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)
32 (defgroup riece-addon-list nil
35 :prefix "riece-addon-list-"
38 (defgroup riece-addon-list-faces nil
39 "Faces for riece-addon-list-mode."
41 :prefix "riece-addon-list-"
42 :group 'riece-addon-list)
44 (defface riece-addon-list-enabled-face
45 '((((class color) (background dark))
46 (:foreground "PaleTurquoise" :bold t))
49 "Face used for displaying the enabled addon."
50 :group 'riece-addon-list-faces)
51 (defvar riece-addon-list-enabled-face 'riece-addon-list-enabled-face)
53 (defface riece-addon-list-disabled-face
54 '((((class color) (background dark))
55 (:foreground "PaleTurquoise" :italic t))
58 "Face used for displaying the disabled addon."
59 :group 'riece-addon-list-faces)
60 (defvar riece-addon-list-disabled-face 'riece-addon-list-disabled-face)
62 (defface riece-addon-list-unsupported-face
63 '((((class color) (background dark))
64 (:foreground "PaleTurquoise"))
67 "Face used for displaying the unsupported addon."
68 :group 'riece-addon-list-faces)
69 (defvar riece-addon-list-unsupported-face 'riece-addon-list-unsupported-face)
71 (defface riece-addon-list-unknown-face
74 "Face used for displaying the unknown addon."
75 :group 'riece-addon-list-faces)
76 (defvar riece-addon-list-unknown-face 'riece-addon-list-unknown-face)
78 (defface riece-addon-list-description-face
81 (:foreground "lightyellow"))
84 (:foreground "blue4"))
87 "Face used for displaying the description addon."
88 :group 'riece-addon-list-faces)
89 (defvar riece-addon-list-description-face 'riece-addon-list-description-face)
91 (defcustom riece-addon-list-mark-face-alist
92 '((?+ . riece-addon-list-enabled-face)
93 (?- . riece-addon-list-disabled-face)
94 (?! . riece-addon-list-unsupported-face)
95 (?? . riece-addon-list-unknown-face))
96 "An alist mapping marks on riece-addon-list-buffer to faces."
98 :group 'riece-addon-list)
100 (defcustom riece-addon-list-font-lock-keywords
101 '(("^\\([-+!?] [^:]+\\): \\(.*\\)"
102 (1 (cdr (assq (aref (match-string 1) 0)
103 riece-addon-list-mark-face-alist)))
104 (2 riece-addon-list-description-face)))
105 "Default expressions to addon in riece-addon-list-mode."
106 :type '(repeat (list string))
107 :group 'riece-addon-list)
109 (defvar riece-addon-list-mode-map
110 (let ((keymap (make-sparse-keymap)))
111 (define-key keymap "+" 'riece-command-enable-addon)
112 (define-key keymap "-" 'riece-command-disable-addon)
113 (define-key keymap "n" 'next-line)
114 (define-key keymap "p" 'previous-line)
115 (define-key keymap " " 'scroll-up)
116 (define-key keymap [delete] 'scroll-down)
117 (define-key keymap "q" 'bury-buffer)
120 (defun riece-load-and-build-addon-dependencies (addons)
121 (let ((load-path (cons riece-addon-directory load-path))
124 (require (car addons)) ;error will be reported here
126 (funcall (or (intern-soft
127 (concat (symbol-name (car addons)) "-requires"))
131 ;; Increment succs' pred count.
132 (if (setq entry (assq (car addons) dependencies))
133 (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
134 (setq dependencies (cons (list (car addons) (length requires))
136 ;; Merge pred's succs.
138 (if (setq entry (assq (car pointer) dependencies))
139 (setcdr (cdr entry) (cons (car addons) (nthcdr 2 entry)))
140 (setq dependencies (cons (list (car pointer) 0 (car addons))
142 (setq pointer (cdr pointer))))
143 (setq addons (cdr addons)))
146 (defun riece-sort-addon-dependencies (dependencies)
147 (let ((pointer dependencies)
150 (if (zerop (nth 1 (car pointer)))
151 (setq dependencies (delq (car pointer) dependencies)
152 queue (cons (car pointer) queue)))
153 (setq pointer (cdr pointer)))
155 (setq addons (cons (cons (car (car queue)) (nthcdr 2 (car queue)))
157 pointer (nthcdr 2 (car queue)))
159 (let* ((entry (assq (car pointer) dependencies))
160 (count (1- (nth 1 entry))))
162 (setq dependencies (delq entry dependencies)
163 queue (nconc queue (list entry)))
164 (setcar (cdr entry) count)))
165 (setq pointer (cdr pointer)))
166 (setq queue (cdr queue)))
168 (error "Circular add-on dependency found: %S" dependencies))
171 (defun riece-resolve-addons (addons)
172 ;; Add files in riece-addon-directory to addons.
173 (if (file-directory-p riece-addon-directory)
178 (unless (file-directory-p
179 (expand-file-name name riece-addon-directory))
180 (intern (file-name-sans-extension name))))
181 (directory-files riece-addon-directory nil "\\`[^.]")))))
183 (setq addons (sort addons (lambda (symbol1 symbol2)
184 (string-lessp (symbol-name symbol1)
185 (symbol-name symbol2)))))
186 (let ((pointer addons))
188 (if (memq (car pointer) (cdr pointer))
189 (setcar pointer nil))
190 (setq pointer (cdr pointer)))
192 ;; Build & resolve dependencies.
193 (riece-resolve-addon-dependencies
194 (riece-load-and-build-addon-dependencies addons)))
196 (defun riece-insinuate-addon (addon &optional verbose)
197 (if (get addon 'riece-addon-insinuated)
199 (message "Add-on %S is alread insinuated" addon))
200 (funcall (intern (concat (symbol-name addon) "-insinuate")))
201 (put addon 'riece-addon-insinuated t)
203 (message "Add-on %S is insinuated" addon))))
205 (defun riece-enable-addon (addon &optional verbose)
206 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
209 (message "Add-on %S doesn't support enable/disable" addon))
210 (if (symbol-value enabled)
212 (message "Add-on %S is already enabled" addon))
213 (funcall (intern (concat (symbol-name addon) "-enable")))
215 (message "Add-on %S enabled" addon))))))
217 (defun riece-disable-addon (addon &optional verbose)
218 (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
221 (message "Add-on %S doesn't support enable/disable" addon))
222 (if (symbol-value enabled)
224 (funcall (intern (concat (symbol-name addon) "-disable")))
226 (message "Add-on %S disabled" addon)))
228 (message "Add-on %S is already enabled" addon))))))
230 (put 'riece-addon-list-mode 'font-lock-defaults
231 '(riece-addon-list-font-lock-keywords t))
233 (defun riece-addon-list-mode ()
234 "Major mode for displaying addon list.
235 All normal editing commands are turned off."
236 (kill-all-local-variables)
237 (buffer-disable-undo)
238 (setq major-mode 'riece-addon-list-mode
240 mode-line-buffer-identification
241 (riece-mode-line-buffer-identification '("Riece: %12b"))
244 (use-local-map riece-addon-list-mode-map)
245 (make-local-variable 'font-lock-defaults)
246 (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
247 ;; In XEmacs, auto-initialization of font-lock is not effective
248 ;; if buffer-file-name is not set.
249 (font-lock-set-defaults)
250 (run-hooks 'riece-addon-list-mode-hook))
252 (defun riece-command-list-addons ()
254 (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
255 (riece-addon-list-mode)
256 (let ((inhibit-read-only t)
258 (pointer (sort (copy-sequence riece-addon-dependencies)
259 (lambda (dependency1 dependency2)
260 (string-lessp (symbol-name (car dependency1))
261 (symbol-name (car dependency2))))))
262 enabled description point)
264 (riece-kill-all-overlays)
266 (setq enabled (intern-soft (concat (symbol-name (car (car pointer)))
268 description (intern-soft (concat (symbol-name (car (car pointer)))
271 (insert (format "%c %S: %s\n"
272 (if (not (featurep (car (car pointer))))
276 (if (symbol-value enabled)
281 (symbol-value description)
282 "(no description)")))
283 (put-text-property point (point) 'riece-addon (car (car pointer)))
284 (setq pointer (cdr pointer)))
286 Symbols in the leftmost column:
288 + The add-on is enabled.
289 - The add-on is disabled.
290 ! The add-on doesn't support enable/disable operation.
291 ? The add-on status is unknown.
293 (insert (substitute-command-keys "
296 `\\[riece-command-enable-addon]' to enable the current add-on.
297 `\\[riece-command-disable-addon]' to disable the current add-on.
299 (goto-char (point-min))
300 (pop-to-buffer (current-buffer))
301 (delete-other-windows)))
303 (defun riece-command-enable-addon (addon)
306 (or (if (eq major-mode 'riece-addon-list-mode)
307 (get-text-property (point) 'riece-addon))
309 (completing-read "Add-on: "
310 (mapcar (lambda (dependency)
311 (list (symbol-name (car dependency))))
312 riece-addon-dependencies)
315 (intern-soft (concat (car pointer)
318 (null (symbol-value enabled)))))
320 (riece-enable-addon addon t)
321 (when (eq major-mode 'riece-addon-list-mode)
322 (riece-command-list-addons)
323 (let ((point (point-min)))
324 (while (and (not (eq (get-text-property point 'riece-addon) addon))
325 (setq point (next-single-property-change point
328 (goto-char point)))))
330 (defun riece-command-disable-addon (addon)
333 (or (if (eq major-mode 'riece-addon-list-mode)
334 (get-text-property (point) 'riece-addon))
336 (completing-read "Add-on: "
337 (mapcar (lambda (dependency)
338 (list (symbol-name (car dependency))))
339 riece-addon-dependencies)
342 (intern-soft (concat (car pointer)
345 (symbol-value enabled))))
347 (riece-disable-addon addon t)
348 (when (eq major-mode 'riece-addon-list-mode)
349 (riece-command-list-addons)
350 (let ((point (point-min)))
351 (while (and (not (eq (get-text-property point 'riece-addon) addon))
352 (setq point (next-single-property-change point
355 (goto-char point)))))
357 (provide 'riece-addon)
359 ;;; riece-addon.el ends here