Switch to recommended form of GPLv3 permissions notice.
[emacs.git] / lisp / cus-dep.el
blob4066c50911ff02336b065ddddc8e485b5d3c84b4
1 ;;; cus-dep.el --- find customization dependencies
2 ;;
3 ;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
7 ;; Keywords: internal
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 (eval-when-compile (require 'cl))
29 (require 'widget)
30 (require 'cus-face)
32 (defvar generated-custom-dependencies-file "cus-load.el"
33 "Output file for \\[custom-make-dependencies].")
35 (defun custom-make-dependencies ()
36 "Batch function to extract custom dependencies from .el files.
37 Usage: emacs -batch -l ./cus-dep.el -f custom-make-dependencies DIRS"
38 (let ((enable-local-eval nil))
39 (set-buffer (get-buffer-create " cus-dep temp"))
40 (dolist (subdir command-line-args-left)
41 (message "Directory %s" subdir)
42 (let ((files (directory-files subdir nil "\\`[^=].*\\.el\\'"))
43 (default-directory (expand-file-name subdir))
44 (preloaded (concat "\\`"
45 (regexp-opt (mapcar
46 (lambda (f)
47 (file-name-sans-extension
48 (file-name-nondirectory f)))
49 preloaded-file-list) t)
50 "\\.el\\'")))
51 (dolist (file files)
52 (when (and (file-exists-p file)
53 ;; Ignore files that are preloaded.
54 (not (string-match preloaded file)))
55 (erase-buffer)
56 (insert-file-contents file)
57 (goto-char (point-min))
58 (string-match "\\`\\(.*\\)\\.el\\'" file)
59 (let ((name (file-name-nondirectory (match-string 1 file)))
60 (load-file-name file))
61 (if (save-excursion
62 (re-search-forward
63 (concat "(provide[ \t\n]+\\('\\|(quote[ \t\n]\\)[ \t\n]*"
64 (regexp-quote name) "[ \t\n)]")
65 nil t))
66 (setq name (intern name)))
67 (condition-case nil
68 (while (re-search-forward
69 "^(def\\(custom\\|face\\|group\\)" nil t)
70 (beginning-of-line)
71 (let ((expr (read (current-buffer))))
72 (condition-case nil
73 (let ((custom-dont-initialize t))
74 (eval expr)
75 (put (nth 1 expr) 'custom-where name))
76 (error nil))))
77 (error nil))))))))
78 (message "Generating %s..." generated-custom-dependencies-file)
79 (set-buffer (find-file-noselect generated-custom-dependencies-file))
80 (erase-buffer)
81 (insert ";;; " (file-name-nondirectory generated-custom-dependencies-file)
82 " --- automatically extracted custom dependencies
83 ;;\n;;; Code:
86 (mapatoms (lambda (symbol)
87 (let ((members (get symbol 'custom-group))
88 where found)
89 (when members
90 (dolist (member
91 ;; So x and no-x builds won't differ.
92 (sort (mapcar 'car members) 'string<))
93 (setq where (get member 'custom-where))
94 (unless (or (null where)
95 (member where found))
96 (push where found)))
97 (when found
98 (insert "(put '" (symbol-name symbol)
99 " 'custom-loads '")
100 (prin1 (nreverse found) (current-buffer))
101 (insert ")\n"))))))
102 (insert "\
103 ;; These are for handling :version. We need to have a minimum of
104 ;; information so `customize-changed-options' could do its job.
106 ;; For groups we set `custom-version', `group-documentation' and
107 ;; `custom-tag' (which are shown in the customize buffer), so we
108 ;; don't have to load the file containing the group.
110 ;; `custom-versions-load-alist' is an alist that has as car a version
111 ;; number and as elts the files that have variables or faces that
112 ;; contain that version. These files should be loaded before showing
113 ;; the customization buffer that `customize-changed-options'
114 ;; generates.
116 ;; This macro is used so we don't modify the information about
117 ;; variables and groups if it's already set. (We don't know when
118 ;; " (file-name-nondirectory generated-custom-dependencies-file)
119 " is going to be loaded and at that time some of the
120 ;; files might be loaded and some others might not).
121 \(defmacro custom-put-if-not (symbol propname value)
122 `(unless (get ,symbol ,propname)
123 (put ,symbol ,propname ,value)))
126 (let ((version-alist nil))
127 (mapatoms (lambda (symbol)
128 (let ((version (get symbol 'custom-version))
129 where)
130 (when version
131 (setq where (get symbol 'custom-where))
132 (when where
133 (if (or (custom-variable-p symbol)
134 (custom-facep symbol))
135 ;; This means it's a variable or a face.
136 (progn
137 (if (assoc version version-alist)
138 (unless
139 (member where
140 (cdr (assoc version version-alist)))
141 (push where (cdr (assoc version version-alist))))
142 (push (list version where) version-alist)))
143 ;; This is a group
144 (insert "(custom-put-if-not '" (symbol-name symbol)
145 " 'custom-version ")
146 (prin1 version (current-buffer))
147 (insert ")\n")
148 (insert "(custom-put-if-not '" (symbol-name symbol))
149 (insert " 'group-documentation ")
150 (prin1 (get symbol 'group-documentation) (current-buffer))
151 (insert ")\n")
152 (when (get symbol 'custom-tag)
153 (insert "(custom-put-if-not '" (symbol-name symbol))
154 (insert " 'custom-tag ")
155 (prin1 (get symbol 'custom-tag) (current-buffer))
156 (insert ")\n"))
157 ))))))
159 (insert "\n(defvar custom-versions-load-alist "
160 (if version-alist "'" ""))
161 (prin1 version-alist (current-buffer))
162 (insert "\n \"For internal use by custom.\")\n"))
164 (insert "\
166 \(provide '" (file-name-sans-extension
167 (file-name-nondirectory generated-custom-dependencies-file)) ")
169 ;; Local Variables:
170 ;; version-control: never
171 ;; no-byte-compile: t
172 ;; no-update-autoloads: t
173 ;; End:\n;;; "
174 (file-name-nondirectory generated-custom-dependencies-file)
175 " ends here\n")
176 (let ((kept-new-versions 10000000))
177 (save-buffer))
178 (message "Generating %s...done" generated-custom-dependencies-file)
179 (kill-emacs))
183 ;; arch-tag: b7b6421a-bf7a-44fd-a382-6f44976bdf68
184 ;;; cus-dep.el ends here