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.
27 (defgroup riece-addon-list nil
33 (defgroup riece-addon-list-faces nil
34 "Faces for riece-addon-list-mode"
36 :prefix "riece-addon-list"
39 (defface riece-addon-list-enabled-face
40 '((((class color) (background dark))
41 (:foreground "PaleTurquoise" :bold t))
44 "Face used for displaying the enabled addon."
45 :group 'riece-addon-list-faces)
46 (defvar riece-addon-list-enabled-face 'riece-addon-list-enabled-face)
48 (defface riece-addon-list-disabled-face
49 '((((class color) (background dark))
50 (:foreground "PaleTurquoise" :italic t))
53 "Face used for displaying the disabled addon."
54 :group 'riece-addon-list-faces)
55 (defvar riece-addon-list-disabled-face 'riece-addon-list-disabled-face)
57 (defface riece-addon-list-unsupported-face
58 '((((class color) (background dark))
59 (:foreground "PaleTurquoise"))
62 "Face used for displaying the unsupported addon."
63 :group 'riece-addon-list-faces)
64 (defvar riece-addon-list-unsupported-face 'riece-addon-list-unsupported-face)
66 (defface riece-addon-list-unknown-face
69 "Face used for displaying the unknown addon."
70 :group 'riece-addon-list-faces)
71 (defvar riece-addon-list-unknown-face 'riece-addon-list-unknown-face)
73 (defface riece-addon-list-description-face
76 (:foreground "lightyellow"))
79 (:foreground "blue4"))
82 "Face used for displaying the description addon."
83 :group 'riece-addon-list-faces)
84 (defvar riece-addon-list-description-face 'riece-addon-list-description-face)
86 (defcustom riece-addon-list-mark-face-alist
87 '((?+ . riece-addon-list-enabled-face)
88 (?- . riece-addon-list-disabled-face)
89 (?! . riece-addon-list-unsupported-face)
90 (?? . riece-addon-list-unknown-face))
91 "An alist mapping marks on riece-addon-list-buffer to faces."
93 :group 'riece-addon-list)
95 (defcustom riece-addon-list-font-lock-keywords
96 '(("^\\([-+!?] [^:]+\\): \\(.*\\)"
97 (1 (cdr (assq (aref (match-string 1) 0)
98 riece-addon-list-mark-face-alist)))
99 (2 riece-addon-list-description-face)))
100 "Default expressions to addon in riece-addon-list-mode."
101 :type '(repeat (list string))
102 :group 'riece-addon-list)
104 (defvar riece-addon-list-mode-map
105 (let ((keymap (make-sparse-keymap)))
106 (define-key keymap "+" 'riece-command-enable-addon)
107 (define-key keymap "-" 'riece-command-disable-addon)
108 (define-key keymap "n" 'next-line)
109 (define-key keymap "p" 'previous-line)
110 (define-key keymap " " 'scroll-up)
111 (define-key keymap [delete] 'scroll-down)
112 (define-key keymap "q" 'bury-buffer)
115 (defun riece-load-and-build-addon-dependencies (addons)
116 (let ((load-path (cons riece-addon-directory load-path))
119 (require (car addons)) ;error will be reported here
121 (funcall (or (intern-soft
122 (concat (symbol-name (car addons)) "-requires"))
126 ;; Increment succs' pred count.
127 (if (setq entry (assq (car addons) dependencies))
128 (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
129 (setq dependencies (cons (list (car addons) (length requires))
131 ;; Merge pred's succs.
133 (if (setq entry (assq (car pointer) dependencies))
135 (cons (car addons) (nthcdr 2 entry)))
136 (setq dependencies (cons (list (car pointer) 0 (car addons))
138 (setq pointer (cdr pointer))))
139 (setq addons (cdr addons)))
142 (defun riece-resolve-addons (addons)
143 (let ((pointer addons)
147 (if (memq (car pointer) (cdr pointer))
148 (setcar pointer nil))
149 (setq pointer (cdr pointer)))
150 (setq dependencies (riece-load-and-build-addon-dependencies
152 pointer dependencies)
155 (if (zerop (nth 1 (car pointer)))
156 (setq dependencies (delq (car pointer) dependencies)
157 queue (cons (car pointer) queue)))
158 (setq pointer (cdr pointer)))
161 (setq addons (cons (car (car queue)) addons)
162 pointer (nthcdr 2 (car queue)))
164 (let* ((entry (assq (car pointer) dependencies))
165 (count (1- (nth 1 entry))))
168 (setq dependencies (delq entry dependencies)
169 queue (nconc queue (list entry))))
170 (setcar (cdr entry) count)))
171 (setq pointer (cdr pointer)))
172 (setq queue (cdr queue)))
174 (error "Circular add-on dependency found"))
177 (defun riece-insinuate-addon (addon &optional verbose)
178 (require addon) ;implicit dependency
179 (funcall (intern (concat (symbol-name addon) "-insinuate")))
181 (message "Add-on %S is insinuated" addon)))
183 (defun riece-enable-addon (addon &optional verbose)
184 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
187 (message "Add-on %S doesn't support enable/disable" addon))
188 (if (symbol-value enabled)
190 (message "Can't enable add-on %S" addon))
191 (funcall (intern (concat (symbol-name addon) "-enable")))
193 (message "Add-on %S enabled" addon))))))
195 (defun riece-disable-addon (addon &optional verbose)
196 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
199 (message "Add-on %S doesn't support enable/disable" addon))
200 (if (symbol-value enabled)
202 (funcall (intern (concat (symbol-name addon) "-disable")))
204 (message "Add-on %S disabled" addon)))
206 (message "Can't disable add-on %S" addon))))))
208 (put 'riece-addon-list-mode 'font-lock-defaults
209 '(riece-addon-list-font-lock-keywords t))
211 (defun riece-addon-list-mode ()
212 "Major mode for displaying addon list.
213 All normal editing commands are turned off."
214 (kill-all-local-variables)
215 (buffer-disable-undo)
216 (setq major-mode 'riece-addon-list-mode
218 mode-line-buffer-identification
219 (riece-mode-line-buffer-identification '("Riece: %12b"))
222 (use-local-map riece-addon-list-mode-map)
223 (make-local-variable 'font-lock-defaults)
224 (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
225 ;; In XEmacs, auto-initialization of font-lock is not affective
226 ;; when buffer-file-name is not set.
227 (font-lock-set-defaults)
228 (run-hooks 'riece-addon-list-mode-hook))
230 (defun riece-command-list-addons ()
232 (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
233 (riece-addon-list-mode)
234 (let ((inhibit-read-only t)
236 (pointer (sort (copy-sequence riece-addons)
237 (lambda (symbol1 symbol2)
238 (string-lessp (symbol-name symbol1)
239 (symbol-name symbol2)))))
240 enabled description point)
242 (riece-kill-all-overlays)
244 (setq enabled (intern-soft (concat (symbol-name (car pointer))
246 description (intern-soft (concat (symbol-name (car pointer))
249 (insert (format "%c %S: %s\n"
250 (if (not (featurep (car pointer)))
254 (if (symbol-value enabled)
259 (symbol-value description)
260 "(no description)")))
261 (put-text-property point (point) 'riece-addon (car pointer))
262 (setq pointer (cdr pointer)))
264 Symbols in the leftmost column:
266 + The add-on is enabled.
267 - The add-on is disabled.
268 ! The add-on doesn't support enable/disable operation.
269 ? The add-on status is unknown.
271 (insert (substitute-command-keys "
274 `\\[riece-command-enable-addon]' to enable the current add-on.
275 `\\[riece-command-disable-addon]' to disable the current add-on.
277 (goto-char (point-min))
278 (pop-to-buffer (current-buffer))
279 (delete-other-windows)))
281 (defun riece-command-enable-addon (addon)
284 (or (if (eq major-mode 'riece-addon-list-mode)
285 (get-text-property (point) 'riece-addon))
286 (completing-read "Add-on: "
287 (mapcar (lambda (addon)
288 (list (symbol-name addon)))
292 (intern-soft (concat (symbol-name
296 (null (symbol-value enabled)))))
298 (riece-enable-addon addon t)
299 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
300 (if (and (eq major-mode 'riece-addon-list-mode)
301 (get-text-property (point) 'riece-addon)
302 enabled (symbol-value enabled))
305 (let ((point (point))
306 (inhibit-read-only t)
310 (put-text-property point (point) 'riece-addon addon))))))
312 (defun riece-command-disable-addon (addon)
315 (or (if (eq major-mode 'riece-addon-list-mode)
316 (get-text-property (point) 'riece-addon))
317 (completing-read "Add-on: "
318 (mapcar (lambda (addon)
319 (list (symbol-name addon)))
323 (intern-soft (concat (symbol-name
327 (symbol-value enabled))))
329 (riece-disable-addon addon t)
330 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
331 (if (and (eq major-mode 'riece-addon-list-mode)
332 (get-text-property (point) 'riece-addon)
333 enabled (null (symbol-value enabled)))
336 (let ((point (point))
337 (inhibit-read-only t)
341 (put-text-property point (point) 'riece-addon addon))))))
343 (provide 'riece-addon)
345 ;;; riece-addon.el ends here