Tabify.
[riece] / 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
32 (defgroup riece-addon-list nil
33   "Add-on management"
34   :tag "Addon"
35   :prefix "riece-"
36   :group 'riece)
37
38 (defgroup riece-addon-list-faces nil
39   "Faces for riece-addon-list-mode"
40   :tag "Faces"
41   :prefix "riece-addon-list"
42   :group 'riece-addon)
43
44 (defface riece-addon-list-enabled-face
45   '((((class color) (background dark))
46      (:foreground "PaleTurquoise" :bold t))
47     (t
48      (: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)
52
53 (defface riece-addon-list-disabled-face
54   '((((class color) (background dark))
55      (:foreground "PaleTurquoise" :italic t))
56     (t
57      (: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)
61
62 (defface riece-addon-list-unsupported-face
63   '((((class color) (background dark))
64      (:foreground "PaleTurquoise"))
65     (t
66      ()))
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)
70
71 (defface riece-addon-list-unknown-face
72   '((t
73      (:foreground "red")))
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)
77
78 (defface riece-addon-list-description-face
79   '((((class color)
80       (background dark))
81      (:foreground "lightyellow"))
82     (((class color)
83       (background light))
84      (:foreground "blue4"))
85     (t
86      ()))
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)
90
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."
97   :type 'list
98   :group 'riece-addon-list)
99
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)
108
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)
118     keymap))
119
120 (defun riece-load-and-build-addon-dependencies (addons)
121   (let ((load-path (cons riece-addon-directory load-path))
122         dependencies)
123     (while addons
124       (require (car addons))            ;error will be reported here
125       (let* ((requires
126               (funcall (or (intern-soft
127                             (concat (symbol-name (car addons)) "-requires"))
128                            #'ignore)))
129              (pointer requires)
130              entry)
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))
135                                    dependencies)))
136         ;; Merge pred's succs.
137         (while pointer
138           (if (setq entry (assq (car pointer) dependencies))
139               (setcdr (cdr entry)
140                       (cons (car addons) (nthcdr 2 entry)))
141             (setq dependencies (cons (list (car pointer) 0 (car addons))
142                                      dependencies)))
143           (setq pointer (cdr pointer))))
144       (setq addons (cdr addons)))
145     dependencies))
146
147 (defun riece-resolve-addons (addons)
148   (let ((pointer addons)
149         dependencies queue)
150     ;; Uniquify, first.
151     (while pointer
152       (if (memq (car pointer) (cdr pointer))
153           (setcar pointer nil))
154       (setq pointer (cdr pointer)))
155     (setq dependencies (riece-load-and-build-addon-dependencies
156                         (delq nil addons))
157           pointer dependencies)
158     ;; Sort them.
159     (while pointer
160       (if (zerop (nth 1 (car pointer)))
161           (setq dependencies (delq (car pointer) dependencies)
162                 queue (cons (car pointer) queue)))
163       (setq pointer (cdr pointer)))
164     (setq addons nil)
165     (while queue
166       (setq addons (cons (car (car queue)) addons)
167             pointer (nthcdr 2 (car queue)))
168       (while pointer
169         (let* ((entry (assq (car pointer) dependencies))
170                (count (1- (nth 1 entry))))
171           (if (zerop count)
172               (progn
173                 (setq dependencies (delq entry dependencies)
174                       queue (nconc queue (list entry))))
175             (setcar (cdr entry) count)))
176         (setq pointer (cdr pointer)))
177       (setq queue (cdr queue)))
178     (if dependencies
179         (error "Circular add-on dependency found"))
180     (nreverse addons)))
181
182 (defun riece-insinuate-addon (addon &optional verbose)
183   (require addon)               ;implicit dependency
184   (funcall (intern (concat (symbol-name addon) "-insinuate")))
185   (if verbose
186       (message "Add-on %S is insinuated" addon)))
187
188 (defun riece-enable-addon (addon &optional verbose)
189   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
190     (if (null enabled)
191         (if verbose
192             (message "Add-on %S doesn't support enable/disable" addon))
193       (if (symbol-value enabled)
194           (if verbose
195               (message "Can't enable add-on %S" addon))
196         (funcall (intern (concat (symbol-name addon) "-enable")))
197         (if verbose
198             (message "Add-on %S enabled" addon))))))
199
200 (defun riece-disable-addon (addon &optional verbose)
201   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
202     (if (null enabled)
203         (if verbose
204             (message "Add-on %S doesn't support enable/disable" addon))
205       (if (symbol-value enabled)
206           (progn
207             (funcall (intern (concat (symbol-name addon) "-disable")))
208             (if verbose
209                 (message "Add-on %S disabled" addon)))
210         (if verbose
211             (message "Can't disable add-on %S" addon))))))
212
213 (put 'riece-addon-list-mode 'font-lock-defaults
214      '(riece-addon-list-font-lock-keywords t))
215
216 (defun riece-addon-list-mode ()
217   "Major mode for displaying addon list.
218 All normal editing commands are turned off."
219   (kill-all-local-variables)
220   (buffer-disable-undo)
221   (setq major-mode 'riece-addon-list-mode
222         mode-name "AddOns"
223         mode-line-buffer-identification
224         (riece-mode-line-buffer-identification '("Riece: %12b"))
225         truncate-lines t
226         buffer-read-only t)
227   (use-local-map riece-addon-list-mode-map)
228   (make-local-variable 'font-lock-defaults)
229   (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
230   ;; In XEmacs, auto-initialization of font-lock is not affective
231   ;; when buffer-file-name is not set.
232   (font-lock-set-defaults)
233   (run-hooks 'riece-addon-list-mode-hook))
234
235 (defun riece-command-list-addons ()
236   (interactive)
237   (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
238   (riece-addon-list-mode)
239   (let ((inhibit-read-only t)
240         buffer-read-only
241         (pointer (sort (copy-sequence riece-addons)
242                        (lambda (symbol1 symbol2)
243                                   (string-lessp (symbol-name symbol1)
244                                                 (symbol-name symbol2)))))
245         enabled description point)
246     (erase-buffer)
247     (riece-kill-all-overlays)
248     (while pointer
249       (setq enabled (intern-soft (concat (symbol-name (car pointer))
250                                          "-enabled"))
251             description (intern-soft (concat (symbol-name (car pointer))
252                                              "-description")))
253       (setq point (point))
254       (insert (format "%c %S: %s\n"
255                       (if (not (featurep (car pointer)))
256                           ??
257                         (if (null enabled)
258                             ?!
259                           (if (symbol-value enabled)
260                               ?+
261                             ?-)))
262                       (car pointer)
263                       (if description
264                           (symbol-value description)
265                         "(no description)")))
266       (put-text-property point (point) 'riece-addon (car pointer))
267       (setq pointer (cdr pointer)))
268     (insert "
269 Symbols in the leftmost column:
270
271   +     The add-on is enabled.
272   -     The add-on is disabled.
273   !     The add-on doesn't support enable/disable operation.
274   ?     The add-on status is unknown.
275 ")
276     (insert (substitute-command-keys "
277 Useful keys:
278
279   `\\[riece-command-enable-addon]' to enable the current add-on.
280   `\\[riece-command-disable-addon]' to disable the current add-on.
281 "))
282     (goto-char (point-min))
283     (pop-to-buffer (current-buffer))
284     (delete-other-windows)))
285
286 (defun riece-command-enable-addon (addon)
287   (interactive
288    (list
289     (or (if (eq major-mode 'riece-addon-list-mode)
290             (get-text-property (point) 'riece-addon))
291         (completing-read "Add-on: "
292                          (mapcar (lambda (addon)
293                                    (list (symbol-name addon)))
294                                  riece-addons)
295                          (lambda (pointer)
296                            (let ((enabled
297                                   (intern-soft (concat (symbol-name
298                                                         (car pointer))
299                                                        "-enabled"))))
300                              (and enabled
301                                   (null (symbol-value enabled)))))
302                          t))))
303   (riece-enable-addon addon t)
304   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
305     (if (and (eq major-mode 'riece-addon-list-mode)
306              (get-text-property (point) 'riece-addon)
307              enabled (symbol-value enabled))
308         (save-excursion
309           (beginning-of-line)
310           (let ((point (point))
311                 (inhibit-read-only t)
312                 buffer-read-only)
313             (delete-char 1)
314             (insert "+")
315             (put-text-property point (point) 'riece-addon addon))))))
316
317 (defun riece-command-disable-addon (addon)
318   (interactive
319    (list
320     (or (if (eq major-mode 'riece-addon-list-mode)
321             (get-text-property (point) 'riece-addon))
322         (completing-read "Add-on: "
323                          (mapcar (lambda (addon)
324                                    (list (symbol-name addon)))
325                                  riece-addons)
326                          (lambda (pointer)
327                            (let ((enabled
328                                   (intern-soft (concat (symbol-name
329                                                         (car pointer))
330                                                        "-enabled"))))
331                              (and enabled
332                                   (symbol-value enabled))))
333                          t))))
334   (riece-disable-addon addon t)
335   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
336     (if (and (eq major-mode 'riece-addon-list-mode)
337              (get-text-property (point) 'riece-addon)
338              enabled (null (symbol-value enabled)))
339         (save-excursion
340           (beginning-of-line)
341           (let ((point (point))
342                 (inhibit-read-only t)
343                 buffer-read-only)
344             (delete-char 1)
345             (insert "-")
346             (put-text-property point (point) 'riece-addon addon))))))
347
348 (provide 'riece-addon)
349
350 ;;; riece-addon.el ends here