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-unknown-face
75 "Face used for displaying the unknown addon."
76 :group 'riece-addon-list-faces)
77 (defvar riece-addon-list-unknown-face 'riece-addon-list-unknown-face)
79 (defface riece-addon-list-description-face
82 (:foreground "lightyellow"))
85 (:foreground "blue4"))
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)
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-unknown-face))
97 "An alist mapping marks on riece-addon-list-buffer to faces."
99 :group 'riece-addon-list)
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)
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 "n" 'next-line)
115 (define-key keymap "p" 'previous-line)
116 (define-key keymap " " 'scroll-up)
117 (define-key keymap [delete] 'scroll-down)
118 (define-key keymap "q" 'bury-buffer)
121 (defun riece-load-and-build-addon-dependencies (addons)
122 (let ((load-path (cons riece-addon-directory load-path))
125 (require (car addons)) ;error will be reported here
127 (funcall (or (intern-soft
128 (concat (symbol-name (car addons)) "-requires"))
132 ;; Increment succs' pred count.
133 (if (setq entry (assq (car addons) dependencies))
134 (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
135 (setq dependencies (cons (list (car addons) (length requires))
137 ;; Merge pred's succs.
139 (if (setq entry (assq (car pointer) dependencies))
140 (setcdr (cdr entry) (cons (car addons) (nthcdr 2 entry)))
141 (setq dependencies (cons (list (car pointer) 0 (car addons))
143 (setq pointer (cdr pointer))))
144 (setq addons (cdr addons)))
147 (defun riece-sort-addon-dependencies (dependencies)
148 (let ((pointer dependencies)
151 (if (zerop (nth 1 (car pointer)))
152 (setq dependencies (delq (car pointer) dependencies)
153 queue (cons (car pointer) queue)))
154 (setq pointer (cdr pointer)))
156 (setq addons (cons (cons (car (car queue)) (nthcdr 2 (car queue)))
158 pointer (nthcdr 2 (car queue)))
160 (let* ((entry (assq (car pointer) dependencies))
161 (count (1- (nth 1 entry))))
163 (setq dependencies (delq entry dependencies)
164 queue (nconc queue (list entry)))
165 (setcar (cdr entry) count)))
166 (setq pointer (cdr pointer)))
167 (setq queue (cdr queue)))
169 (error "Circular add-on dependency found: %S" dependencies))
172 (defun riece-resolve-addons (addons)
173 ;; Add files in riece-addon-directory to addons.
174 (if (file-directory-p riece-addon-directory)
179 (unless (file-directory-p
180 (expand-file-name name riece-addon-directory))
181 (intern (file-name-sans-extension name))))
182 (directory-files riece-addon-directory nil "\\`[^.]")))))
184 (setq addons (sort addons (lambda (symbol1 symbol2)
185 (string-lessp (symbol-name symbol1)
186 (symbol-name symbol2)))))
187 (let ((pointer addons))
189 (if (memq (car pointer) (cdr pointer))
190 (setcar pointer nil))
191 (setq pointer (cdr pointer)))
193 ;; Build & resolve dependencies.
194 (riece-sort-addon-dependencies
195 (riece-load-and-build-addon-dependencies addons)))
197 (defun riece-insinuate-addon (addon &optional verbose)
198 (if (get addon 'riece-addon-insinuated)
200 (message "Add-on %S is already insinuated" addon))
201 (funcall (intern (concat (symbol-name addon) "-insinuate")))
202 (put addon 'riece-addon-insinuated t)
204 (message "Add-on %S is insinuated" addon))))
206 (defun riece-uninstall-addon (addon &optional verbose)
207 (if (not (get addon 'riece-addon-insinuated))
209 (message "Add-on %S is not insinuated" addon))
210 (let ((entry (assq addon riece-addon-dependencies))
211 (enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
214 (if (= (length (cdr entry)) 1)
215 (error "%S depends %S" (car (cdr entry)) addon)
216 (error "%s depends %S" (mapconcat #'identity (cdr entry) ",")
219 (symbol-value enabled))
220 (riece-disable-addon addon verbose))
221 (funcall (or (intern-soft (concat (symbol-name addon)
224 (setq riece-addon-dependencies
225 (delq entry riece-addon-dependencies))
226 (put addon 'riece-addon-insinuated nil)))
228 (message "Add-on %S is uninstalled" addon)))))
230 (defun riece-enable-addon (addon &optional verbose)
231 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
234 (message "Add-on %S doesn't support enable/disable" addon))
235 (if (symbol-value enabled)
237 (message "Add-on %S is already enabled" addon))
238 (funcall (intern (concat (symbol-name addon) "-enable")))
240 (message "Add-on %S enabled" addon))))))
242 (defun riece-disable-addon (addon &optional verbose)
243 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
246 (message "Add-on %S doesn't support enable/disable" addon))
247 (if (symbol-value enabled)
249 (funcall (intern (concat (symbol-name addon) "-disable")))
251 (message "Add-on %S disabled" addon)))
253 (message "Add-on %S is already enabled" addon))))))
255 (put 'riece-addon-list-mode 'font-lock-defaults
256 '(riece-addon-list-font-lock-keywords t))
258 (defun riece-addon-list-mode ()
259 "Major mode for displaying addon list.
260 All normal editing commands are turned off."
261 (kill-all-local-variables)
262 (buffer-disable-undo)
263 (setq major-mode 'riece-addon-list-mode
265 mode-line-buffer-identification
266 (riece-mode-line-buffer-identification '("Riece: %12b"))
269 (use-local-map riece-addon-list-mode-map)
270 (make-local-variable 'font-lock-defaults)
271 (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
272 ;; In XEmacs, auto-initialization of font-lock is not effective
273 ;; if buffer-file-name is not set.
274 (font-lock-set-defaults)
275 (run-hooks 'riece-addon-list-mode-hook))
277 (defun riece-command-list-addons ()
279 (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
280 (riece-addon-list-mode)
281 (let ((inhibit-read-only t)
283 (pointer riece-addon-dependencies)
284 module-description-alist
285 description enabled point)
288 (setq description (intern-soft (concat (symbol-name (car (car pointer)))
290 module-description-alist
291 (cons (cons (car (car pointer))
293 (symbol-value description)
295 module-description-alist)
296 pointer (cdr pointer)))
297 (setq pointer riece-addon-modules)
299 (unless (assq (car (car pointer))
300 module-description-alist)
301 (setq module-description-alist
302 (cons (car pointer) module-description-alist)))
303 (setq pointer (cdr pointer)))
305 (riece-kill-all-overlays)
306 (setq pointer module-description-alist)
308 (setq enabled (intern-soft (concat (symbol-name (car (car pointer)))
311 (insert (format "%c %S: %s\n"
312 (if (not (featurep (car (car pointer))))
316 (if (symbol-value enabled)
320 (cdr (car pointer))))
321 (put-text-property point (point) 'riece-addon (car (car pointer)))
322 (setq pointer (cdr pointer)))
324 Symbols in the leftmost column:
326 + The add-on is enabled.
327 - The add-on is disabled.
328 ! The add-on doesn't support enable/disable operation.
329 ? The add-on status is unknown.
331 (insert (substitute-command-keys "
334 `\\[riece-command-enable-addon]' to enable the current add-on.
335 `\\[riece-command-disable-addon]' to disable the current add-on.
337 (goto-char (point-min))
338 (pop-to-buffer (current-buffer))
339 (delete-other-windows)))
341 (defun riece-command-enable-addon (addon)
344 (or (if (eq major-mode 'riece-addon-list-mode)
345 (get-text-property (point) 'riece-addon))
347 (completing-read "Add-on: "
348 (mapcar (lambda (dependency)
349 (list (symbol-name (car dependency))))
350 riece-addon-dependencies)
353 (intern-soft (concat (car pointer)
356 (null (symbol-value enabled)))))
358 (riece-enable-addon addon t)
359 (when (eq major-mode 'riece-addon-list-mode)
360 (riece-command-list-addons)
361 (let ((point (point-min)))
362 (while (and (not (eq (get-text-property point 'riece-addon) addon))
363 (setq point (next-single-property-change point
366 (goto-char point)))))
368 (defun riece-command-disable-addon (addon)
371 (or (if (eq major-mode 'riece-addon-list-mode)
372 (get-text-property (point) 'riece-addon))
374 (completing-read "Add-on: "
375 (mapcar (lambda (dependency)
376 (list (symbol-name (car dependency))))
377 riece-addon-dependencies)
380 (intern-soft (concat (car pointer)
383 (symbol-value enabled))))
385 (riece-disable-addon addon t)
386 (when (eq major-mode 'riece-addon-list-mode)
387 (riece-command-list-addons)
388 (let ((point (point-min)))
389 (while (and (not (eq (get-text-property point 'riece-addon) addon))
390 (setq point (next-single-property-change point
393 (goto-char point)))))
395 (provide 'riece-addon)
397 ;;; riece-addon.el ends here