|
209
|
1 ;;; packages.el --- Low level support for XEmacs packages
|
|
|
2
|
|
|
3 ;; Copyright (C) 1997 Free Software Foundation, Inc.
|
|
|
4
|
|
|
5 ;; Author: Steven L Baur <steve@altair.xemacs.org>
|
|
235
|
6 ;; Maintainer: Steven L Baur <steve@altair.xemacs.org>
|
|
209
|
7 ;; Keywords: internal, lisp, dumped
|
|
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
|
10
|
|
|
11 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
12 ;; under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
14 ;; any later version.
|
|
|
15
|
|
|
16 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
19 ;; General Public License for more details.
|
|
|
20
|
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
|
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
|
23 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
24 ;; 02111-1307, USA.
|
|
|
25
|
|
|
26 ;;; Synched up with: Not in FSF
|
|
|
27
|
|
|
28 ;;; Commentary:
|
|
|
29
|
|
|
30 ;; This file is dumped with XEmacs.
|
|
|
31
|
|
|
32 ;; This file provides low level facilities for XEmacs startup --
|
|
|
33 ;; particularly regarding the package setup. This code has to run in
|
|
|
34 ;; what we call "bare temacs" -- i.e. XEmacs without the usual Lisp
|
|
|
35 ;; environment. Pay special attention:
|
|
|
36
|
|
|
37 ;; - not to use the `lambda' macro. Use #'(lambda ...) instead.
|
|
|
38 ;; (this goes for any package loaded before `subr.el'.)
|
|
|
39 ;;
|
|
|
40 ;; - not to use macros, because they are not yet available (and this
|
|
|
41 ;; file must be loadable uncompiled.) This rules out CL-style
|
|
|
42 ;; macros like `when', for instance.
|
|
|
43 ;;
|
|
|
44 ;; - not to use `defcustom'. If you must add user-customizable
|
|
|
45 ;; variables here, use `defvar', and add the variable to
|
|
|
46 ;; `cus-start.el'.
|
|
|
47
|
|
|
48 ;; Because of all this, make sure that the stuff you put here really
|
|
|
49 ;; belongs here.
|
|
|
50
|
|
267
|
51 ;; This file requires find-paths.el.
|
|
209
|
52
|
|
|
53 ;;; Code:
|
|
|
54
|
|
227
|
55 ;;; Package versioning
|
|
|
56
|
|
|
57 (defvar packages-package-list nil
|
|
|
58 "database of loaded packages and version numbers")
|
|
|
59
|
|
267
|
60 (defvar early-packages nil
|
|
|
61 "Packages early in the load path.")
|
|
|
62
|
|
|
63 (defvar early-package-load-path nil
|
|
|
64 "Load path for packages early in the load path.")
|
|
|
65
|
|
272
|
66 (defvar late-packages nil
|
|
267
|
67 "Packages late in the load path.")
|
|
|
68
|
|
|
69 (defvar late-package-load-path nil
|
|
|
70 "Load path for packages late in the load path.")
|
|
|
71
|
|
272
|
72 (defvar last-packages nil
|
|
|
73 "Packages last in the load path.")
|
|
|
74
|
|
|
75 (defvar last-package-load-path nil
|
|
|
76 "Load path for packages last in the load path.")
|
|
|
77
|
|
235
|
78 (defun package-get-key-1 (info key)
|
|
|
79 "Locate keyword `key' in list."
|
|
|
80 (cond ((null info)
|
|
|
81 nil)
|
|
|
82 ((eq (car info) key)
|
|
|
83 (nth 1 info))
|
|
|
84 (t (package-get-key-1 (cddr info) key))))
|
|
|
85
|
|
|
86 (defun package-get-key (name key)
|
|
|
87 "Get info `key' from package `name'."
|
|
|
88 (let ((info (assq name packages-package-list)))
|
|
|
89 (when info
|
|
|
90 (package-get-key-1 (cdr info) key))))
|
|
|
91
|
|
|
92 (defun package-provide (name &rest attributes)
|
|
|
93 (let ((info (if (and attributes (floatp (car attributes)))
|
|
|
94 (list :version (car attributes))
|
|
|
95 attributes)))
|
|
|
96 (remassq name packages-package-list)
|
|
|
97 (setq packages-package-list
|
|
|
98 (cons (cons name info) packages-package-list))))
|
|
227
|
99
|
|
|
100 (defun package-require (name version)
|
|
|
101 (let ((pkg (assq name packages-package-list)))
|
|
|
102 (cond ((null pkg)
|
|
|
103 (error "Package %s has not been loaded into this XEmacsen"
|
|
|
104 name))
|
|
239
|
105 ((< (package-get-key name :version) version)
|
|
227
|
106 (error "Need version %g of package %s, got version %g"
|
|
|
107 version name (cdr pkg)))
|
|
|
108 (t t))))
|
|
|
109
|
|
|
110 ;;; Build time stuff
|
|
|
111
|
|
209
|
112 (defvar autoload-file-name "auto-autoloads.el"
|
|
|
113 "Filename that autoloads are expected to be found in.")
|
|
|
114
|
|
|
115 (defvar packages-hardcoded-lisp
|
|
|
116 '(
|
|
253
|
117 #+infodock "id-vers"
|
|
|
118 #+infodock "easymenu-id-xemacs"
|
|
209
|
119 )
|
|
|
120 "Lisp packages that are always dumped with XEmacs")
|
|
|
121
|
|
|
122 (defvar packages-useful-lisp
|
|
|
123 '("bytecomp"
|
|
|
124 "byte-optimize"
|
|
|
125 "shadow"
|
|
|
126 "cl-macs")
|
|
|
127 "Lisp packages that need early byte compilation.")
|
|
|
128
|
|
|
129 (defvar packages-unbytecompiled-lisp
|
|
|
130 '("paths.el"
|
|
227
|
131 "dumped-lisp.el"
|
|
|
132 "dumped-pkg-lisp.el"
|
|
261
|
133 "version.el"
|
|
|
134 "Installation.el")
|
|
209
|
135 "Lisp packages that should not be byte compiled.")
|
|
|
136
|
|
|
137
|
|
|
138 ;; Copied from help.el, could possibly move it to here permanently.
|
|
|
139 ;; Unlike the FSF version, our `locate-library' uses the `locate-file'
|
|
|
140 ;; primitive, which should make it lightning-fast.
|
|
|
141
|
|
|
142 (defun locate-library (library &optional nosuffix path interactive-call)
|
|
|
143 "Show the precise file name of Emacs library LIBRARY.
|
|
|
144 This command searches the directories in `load-path' like `M-x load-library'
|
|
|
145 to find the file that `M-x load-library RET LIBRARY RET' would load.
|
|
|
146 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el'
|
|
|
147 to the specified name LIBRARY.
|
|
|
148
|
|
|
149 If the optional third arg PATH is specified, that list of directories
|
|
|
150 is used instead of `load-path'."
|
|
|
151 (interactive (list (read-string "Locate library: ")
|
|
|
152 nil nil
|
|
|
153 t))
|
|
|
154 (let ((result
|
|
|
155 (locate-file
|
|
|
156 library
|
|
|
157 (or path load-path)
|
|
|
158 (cond ((or (rassq 'jka-compr-handler file-name-handler-alist)
|
|
|
159 (and (boundp 'find-file-hooks)
|
|
|
160 (member 'crypt-find-file-hook find-file-hooks)))
|
|
|
161 ;; Compression involved.
|
|
|
162 (if nosuffix
|
|
|
163 ":.gz:.Z"
|
|
|
164 ".elc:.elc.gz:elc.Z:.el:.el.gz:.el.Z::.gz:.Z"))
|
|
|
165 (t
|
|
|
166 ;; No compression.
|
|
|
167 (if nosuffix
|
|
|
168 ""
|
|
|
169 ".elc:.el:")))
|
|
|
170 4)))
|
|
|
171 (and interactive-call
|
|
|
172 (if result
|
|
|
173 (message "Library is file %s" result)
|
|
|
174 (message "No library %s in search path" library)))
|
|
|
175 result))
|
|
|
176
|
|
|
177 (defun packages-add-suffix (str)
|
|
|
178 (if (null (string-match "\\.el\\'" str))
|
|
|
179 (concat str ".elc")
|
|
|
180 str))
|
|
|
181
|
|
235
|
182 (defun packages-list-autoloads-path ()
|
|
209
|
183 "List autoloads from precomputed load-path."
|
|
|
184 (let ((path load-path)
|
|
|
185 autoloads)
|
|
|
186 (while path
|
|
|
187 (if (file-exists-p (concat (car path)
|
|
|
188 autoload-file-name))
|
|
|
189 (setq autoloads (cons (concat (car path)
|
|
|
190 autoload-file-name)
|
|
|
191 autoloads)))
|
|
|
192 (setq path (cdr path)))
|
|
|
193 autoloads))
|
|
|
194
|
|
235
|
195 (defun packages-list-autoloads ()
|
|
209
|
196 "List autoload files in (what will be) the normal lisp search path.
|
|
|
197 This function is used during build to find where the global symbol files so
|
|
|
198 they can be perused for their useful information."
|
|
|
199 ;; Source directory may not be initialized yet.
|
|
|
200 ;; (print (prin1-to-string load-path))
|
|
|
201 (if (null source-directory)
|
|
215
|
202 (setq source-directory (concat (car load-path) "./")))
|
|
235
|
203 (let ((files (directory-files (file-name-as-directory source-directory)
|
|
|
204 t ".*"))
|
|
209
|
205 file autolist)
|
|
215
|
206 ;; (print (prin1-to-string source-directory))
|
|
|
207 ;; (print (prin1-to-string files))
|
|
209
|
208 (while (setq file (car-safe files))
|
|
|
209 (if (and (file-directory-p file)
|
|
|
210 (file-exists-p (concat file "/" autoload-file-name)))
|
|
|
211 (setq autolist (cons (concat file "/" autoload-file-name)
|
|
|
212 autolist)))
|
|
|
213 (setq files (cdr files)))
|
|
|
214 autolist))
|
|
|
215
|
|
235
|
216 ;; The following function cannot be called from a bare temacs
|
|
|
217 (defun packages-new-autoloads ()
|
|
|
218 "Return autoloads files that have been added or modified since XEmacs dump."
|
|
|
219 (require 'loadhist)
|
|
|
220 (let ((me (concat invocation-directory invocation-name))
|
|
|
221 (path load-path)
|
|
|
222 result dir)
|
|
|
223 (while path
|
|
|
224 (setq dir (file-truename (car path)))
|
|
|
225 (let ((autoload-file (file-name-sans-extension (concat
|
|
|
226 dir
|
|
|
227 autoload-file-name))))
|
|
|
228 ;; Check for:
|
|
|
229 ;; 1. An auto-autoload file that hasn't provided a feature (because
|
|
|
230 ;; it has been installed since XEmacs was dumped).
|
|
|
231 ;; 2. auto-autoload.el being newer than the executable
|
|
|
232 ;; 3. auto-autoload.elc being newer than the executable (the .el
|
|
|
233 ;; could be missing or compressed)
|
|
|
234 (when (or (and (null (file-provides autoload-file))
|
|
|
235 (or (file-exists-p (concat autoload-file ".elc"))
|
|
|
236 (file-exists-p (concat autoload-file ".el"))))
|
|
|
237 (and (file-newer-than-file-p (concat autoload-file ".el") me)
|
|
|
238 (setq autoload-file (concat autoload-file ".el")))
|
|
|
239 (and (file-newer-than-file-p (concat autoload-file
|
|
|
240 ".elc")
|
|
|
241 me)
|
|
|
242 (setq autoload-file (concat autoload-file ".elc"))))
|
|
|
243 (push autoload-file result)))
|
|
|
244 (setq path (cdr path)))
|
|
|
245 result))
|
|
|
246
|
|
|
247 ;; The following function cannot be called from a bare temacs
|
|
|
248 (defun packages-reload-autoloads ()
|
|
|
249 "Reload new or updated auto-autoloads files.
|
|
|
250 This is an extremely dangerous function to call after the user-init-files
|
|
|
251 is run. Don't call it or you'll be sorry."
|
|
|
252 (let ((autoload-list (packages-new-autoloads)))
|
|
|
253 (while autoload-list
|
|
|
254 (let* ((autoload-file (car autoload-list))
|
|
|
255 (feature (car-safe (file-provides autoload-file))))
|
|
|
256 (when feature
|
|
|
257 ;; (message "(unload-feature %S)" feature)
|
|
|
258 (unload-feature feature))
|
|
237
|
259 (condition-case nil
|
|
|
260 (load autoload-file)
|
|
|
261 (t nil)))
|
|
235
|
262 (setq autoload-list (cdr autoload-list)))))
|
|
|
263
|
|
|
264 ;; The following function cannot be called from a bare temacs
|
|
|
265 (defun packages-reload-dumped-lisp ()
|
|
|
266 "Reload new or updated dumped lisp files (with exceptions).
|
|
|
267 This is an extremely dangerous function to call at any time."
|
|
|
268 ;; Nothing for the moment
|
|
|
269 nil)
|
|
|
270
|
|
209
|
271 ;; Data-directory is really a list now. Provide something to search it for
|
|
|
272 ;; directories.
|
|
|
273
|
|
|
274 (defun locate-data-directory (name &optional dir-list)
|
|
|
275 "Locate a directory in a search path DIR-LIST (a list of directories).
|
|
|
276 If no DIR-LIST is supplied, it defaults to `data-directory-list'."
|
|
|
277 (unless dir-list
|
|
|
278 (setq dir-list data-directory-list))
|
|
|
279 (let (found found-dir)
|
|
|
280 (while (and (null found-dir) dir-list)
|
|
|
281 (setq found (concat (car dir-list) name "/")
|
|
|
282 found-dir (file-directory-p found))
|
|
|
283 (or found-dir
|
|
|
284 (setq found nil))
|
|
|
285 (setq dir-list (cdr dir-list)))
|
|
|
286 found))
|
|
|
287
|
|
215
|
288 ;; Data-directory is really a list now. Provide something to search it for
|
|
|
289 ;; files.
|
|
|
290
|
|
|
291 (defun locate-data-file (name &optional dir-list)
|
|
|
292 "Locate a file in a search path DIR-LIST (a list of directories).
|
|
239
|
293 If no DIR-LIST is supplied, it defaults to `data-directory-list'.
|
|
|
294 This function is basically a wrapper over `locate-file'."
|
|
215
|
295 (unless dir-list
|
|
|
296 (setq dir-list data-directory-list))
|
|
239
|
297 (locate-file name dir-list))
|
|
215
|
298
|
|
267
|
299 ;; Path setup
|
|
|
300
|
|
|
301 (defun packages-find-package-path (roots)
|
|
|
302 "Construct the package path underneath installation roots ROOTS."
|
|
|
303 (let ((envvar-value (getenv "EMACSPACKAGEPATH")))
|
|
|
304 (if envvar-value
|
|
|
305 (decode-path-internal envvar-value)
|
|
|
306 (let ((site-base-directory (paths-find-site-directory roots "packages"))
|
|
|
307 (version-base-directory (paths-find-version-directory roots "packages")))
|
|
|
308 (if (or site-base-directory version-base-directory)
|
|
|
309 (let ((site-mule-directory
|
|
|
310 (and (featurep 'mule)
|
|
|
311 (paths-find-site-directory roots
|
|
|
312 "mule-packages")))
|
|
|
313 (version-mule-directory
|
|
|
314 (and (featurep 'mule)
|
|
|
315 (paths-find-version-directory roots
|
|
272
|
316 "mule-packages")))
|
|
|
317 ;; There needs to be a cleverer way of doing this
|
|
|
318 (site-infodock-directory
|
|
|
319 (and (featurep 'infodock)
|
|
|
320 (paths-find-site-directory roots
|
|
|
321 "infodock-packages")))
|
|
|
322 (version-infodock-directory
|
|
|
323 (and (featurep 'infodock)
|
|
|
324 (paths-find-version-directory roots
|
|
|
325 "infodock-packages"))))
|
|
267
|
326 (append '("~/.xemacs/")
|
|
|
327 '(nil)
|
|
272
|
328 (and version-infodock-directory
|
|
|
329 (null (string-equal version-infodock-directory
|
|
|
330 site-infodock-directory))
|
|
|
331 (list version-infodock-directory))
|
|
|
332 (and site-infodock-directory
|
|
|
333 (list site-infodock-directory))
|
|
267
|
334 (and version-mule-directory
|
|
|
335 (null (string-equal version-mule-directory
|
|
|
336 site-mule-directory))
|
|
|
337 (list version-mule-directory))
|
|
|
338 (and site-mule-directory
|
|
|
339 (list site-mule-directory))
|
|
|
340 (and version-base-directory
|
|
|
341 (null (string-equal version-base-directory
|
|
|
342 site-base-directory))
|
|
|
343 (list version-base-directory))
|
|
|
344 (and site-base-directory
|
|
|
345 (list site-base-directory))))
|
|
|
346 configure-package-path)))))
|
|
|
347
|
|
|
348 (defvar packages-special-bases '("etc" "info" "lisp" "lib-src" "bin")
|
|
|
349 "Special subdirectories of packages.")
|
|
|
350
|
|
|
351 (defun packages-find-packages-in-directories (directories)
|
|
|
352 "Find all packages underneath directories in DIRECTORIES."
|
|
|
353 (paths-find-recursive-path directories
|
|
|
354 (append paths-version-control-bases
|
|
|
355 packages-special-bases)))
|
|
|
356
|
|
|
357 (defun packages-split-path (path)
|
|
|
358 "Split PATH at NIL, return pair with two components.
|
|
|
359 The second component is shared with PATH."
|
|
272
|
360 (let ((reverse-tail '())
|
|
|
361 (rest path))
|
|
|
362 (while (and rest (null (null (car rest))))
|
|
|
363 (setq reverse-tail (cons (car rest) reverse-tail))
|
|
|
364 (setq rest (cdr rest)))
|
|
|
365 (if (null rest)
|
|
|
366 (cons path nil)
|
|
|
367 (cons (nreverse reverse-tail) (cdr rest)))))
|
|
267
|
368
|
|
|
369 (defun packages-find-packages (package-path &optional inhibit)
|
|
|
370 "Search for all packages in PACKAGE-PATH.
|
|
272
|
371 PACKAGE-PATH may distinguish (by NIL-separation) between early,
|
|
|
372 late and last packages.
|
|
267
|
373 If INHIBIT is non-NIL, return empty paths.
|
|
272
|
374 This returns (LIST EARLY-PACKAGES LATE-PACKAGES LAST-PACKAGES)."
|
|
267
|
375 (if inhibit
|
|
272
|
376 (list '() '() '())
|
|
|
377 ;; When in doubt, it's late
|
|
267
|
378 (let* ((stuff (packages-split-path package-path))
|
|
272
|
379 (early (and (cdr stuff) (car stuff)))
|
|
|
380 (late+last (or (cdr stuff) (car stuff)))
|
|
|
381 (stuff (packages-split-path late+last))
|
|
|
382 (late (car stuff))
|
|
|
383 (last (cdr stuff)))
|
|
|
384 (list (packages-find-packages-in-directories early)
|
|
|
385 (packages-find-packages-in-directories late)
|
|
|
386 (packages-find-packages-in-directories last)))))
|
|
267
|
387
|
|
|
388 (defun packages-find-package-library-path (packages suffixes)
|
|
|
389 "Construct a path into a component of the packages hierarchy.
|
|
|
390 PACKAGES is a list of package directories.
|
|
|
391 SUFFIXES is a list of names of package subdirectories to look for."
|
|
|
392 (let ((directories
|
|
|
393 (apply
|
|
|
394 #'append
|
|
|
395 (mapcar #'(lambda (package)
|
|
|
396 (mapcar #'(lambda (suffix)
|
|
|
397 (concat package suffix))
|
|
|
398 suffixes))
|
|
|
399 packages))))
|
|
|
400 (paths-directories-which-exist directories)))
|
|
|
401
|
|
|
402 (defun packages-find-package-load-path (packages)
|
|
|
403 "Construct the load-path component for packages.
|
|
|
404 PACKAGES is a list of package directories."
|
|
|
405 (paths-find-recursive-load-path
|
|
|
406 (packages-find-package-library-path packages '("lisp/"))))
|
|
|
407
|
|
|
408 (defun packages-find-package-exec-path (packages)
|
|
|
409 (packages-find-package-library-path packages
|
|
|
410 (list (concat "bin/" system-configuration "/")
|
|
|
411 "lib-src/")))
|
|
|
412
|
|
|
413 (defun packages-find-package-info-path (packages)
|
|
|
414 (packages-find-package-library-path packages '("info/")))
|
|
|
415
|
|
|
416 (defun packages-find-package-data-path (packages)
|
|
|
417 (packages-find-package-library-path packages '("etc/")))
|
|
|
418
|
|
|
419 ;; Loading package initialization files
|
|
|
420
|
|
|
421 (defun packages-load-package-lisps (package-load-path base)
|
|
|
422 "Load all Lisp files of a certain name along a load path.
|
|
|
423 BASE is the base name of the files."
|
|
|
424 (mapc #'(lambda (dir)
|
|
|
425 (let ((file-name (expand-file-name base dir)))
|
|
|
426 (if (file-exists-p file-name)
|
|
|
427 (condition-case error
|
|
|
428 (load file-name)
|
|
|
429 (error
|
|
|
430 (warn (format "Autoload error in: %s:\n\t%s"
|
|
|
431 file-name
|
|
|
432 (with-output-to-string
|
|
|
433 (display-error error nil)))))))))
|
|
|
434 package-load-path))
|
|
|
435
|
|
|
436 (defun packages-load-package-auto-autoloads (package-load-path)
|
|
|
437 "Load auto-autoload files along a load path."
|
|
|
438 (packages-load-package-lisps package-load-path
|
|
|
439 (file-name-sans-extension autoload-file-name)))
|
|
|
440
|
|
|
441 (defun packages-handle-package-dumped-lisps (handle package-load-path)
|
|
|
442 "Load dumped-lisp.el files along a load path.
|
|
|
443 Call HANDLE on each file off definitions of PACKAGE-LISP there."
|
|
|
444 (mapc #'(lambda (dir)
|
|
|
445 (let ((file-name (expand-file-name "dumped-lisp.el" dir)))
|
|
|
446 (if (file-exists-p file-name)
|
|
|
447 (let (package-lisp
|
|
|
448 ;; 20.4 packages could set this
|
|
|
449 preloaded-file-list)
|
|
|
450 (load file-name)
|
|
|
451 ;; dumped-lisp.el could have set this ...
|
|
|
452 (if package-lisp
|
|
|
453 (mapc #'(lambda (base)
|
|
272
|
454 (funcall handle base))
|
|
267
|
455 package-lisp))))))
|
|
|
456 package-load-path))
|
|
|
457
|
|
|
458 (defun packages-load-package-dumped-lisps (package-load-path)
|
|
|
459 "Load dumped-lisp.el files along a load path.
|
|
|
460 Also load files off PACKAGE-LISP definitions there"
|
|
|
461 (packages-handle-package-dumped-lisps #'load package-load-path))
|
|
|
462
|
|
|
463 (defun packages-collect-package-dumped-lisps (package-load-path)
|
|
|
464 "Load dumped-lisp.el files along a load path.
|
|
|
465 Return list of files off PACKAGE-LISP definitions there"
|
|
|
466 (let ((*files* '()))
|
|
|
467 (packages-handle-package-dumped-lisps
|
|
|
468 #'(lambda (file)
|
|
272
|
469 (setq *files* (cons file *files*)))
|
|
267
|
470 package-load-path)
|
|
|
471 (reverse *files*)))
|
|
209
|
472
|
|
|
473 (provide 'packages)
|
|
|
474
|
|
|
475 ;;; packages.el ends here
|
