428
|
1 ;;; setup-paths.el --- setup various XEmacs paths
|
|
2
|
|
3 ;; Copyright (C) 1985-1986, 1990, 1992-1997 Free Software Foundation, Inc.
|
|
4 ;; Copyright (c) 1993, 1994 Sun Microsystems, Inc.
|
|
5 ;; Copyright (C) 1995 Board of Trustees, University of Illinois
|
1330
|
6 ;; Copyright (C) 2003 Ben Wing.
|
428
|
7
|
2456
|
8 ;; Author: Mike Sperber <mike@xemacs.orgx>
|
428
|
9 ;; Maintainer: XEmacs Development Team
|
|
10 ;; Keywords: internal, dumped
|
|
11
|
|
12 ;; This file is part of XEmacs.
|
|
13
|
|
14 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
15 ;; under the terms of the GNU General Public License as published by
|
|
16 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
17 ;; any later version.
|
|
18
|
|
19 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
22 ;; General Public License for more details.
|
|
23
|
|
24 ;; You should have received a copy of the GNU General Public License
|
|
25 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
26 ;; Free Software Foundation, 59 Temple Place - Suite 330,
|
|
27 ;; Boston, MA 02111-1307, USA.
|
|
28
|
|
29 ;;; Synched up with: Not in FSF.
|
|
30
|
|
31 ;;; Commentary:
|
|
32
|
|
33 ;; This file is dumped with XEmacs.
|
|
34
|
776
|
35 ;; This file contains functions and variables that describe and construct
|
|
36 ;; the various paths into the XEmacs hierarchy from a global viewpoint.
|
2456
|
37
|
|
38 ;; This file doesn't actually set any global variable, and doesn't
|
|
39 ;; contain any state---it just contains the functionality for
|
|
40 ;; searching directories and constructing paths.
|
428
|
41
|
|
42 ;; It requires find-paths.el and packages.el.
|
1330
|
43
|
|
44 ;;; Code:
|
|
45
|
|
46 ;(setq debug-paths t)
|
|
47
|
428
|
48
|
460
|
49 (defvar paths-core-load-path-depth 0
|
428
|
50 "Depth of load-path searches in core Lisp paths.")
|
|
51
|
452
|
52 (defvar paths-site-load-path-depth 1
|
|
53 "Depth of load-path searches in site Lisp paths.")
|
|
54
|
460
|
55 (defvar paths-mule-load-path-depth 0
|
|
56 "Depth of load-path searches in Mule Lisp paths.")
|
|
57
|
3813
|
58 (defvar paths-module-load-path-depth 1
|
|
59 "Depth of load-path searches in module paths.")
|
|
60
|
428
|
61 (defvar paths-default-info-directories
|
|
62 (mapcar (function
|
|
63 (lambda (dirlist)
|
|
64 (paths-construct-path
|
|
65 dirlist (char-to-string directory-sep-char))))
|
|
66 '(("usr" "local" "info")
|
|
67 ("usr" "info")
|
|
68 ("usr" "local" "share" "info")
|
|
69 ("usr" "share" "info")))
|
|
70 "Directories appended to the end of the info path by default.")
|
|
71
|
1330
|
72
|
|
73 ;;; Basic utility functions.
|
|
74
|
|
75 (defun paths-emacs-root-p (directory)
|
|
76 "Check if DIRECTORY is a plausible installation root."
|
|
77 (or
|
|
78 ;; installed
|
|
79 (paths-file-readable-directory-p (paths-construct-path (list directory
|
|
80 "lib"
|
|
81 (construct-emacs-version-name))))
|
|
82 ;; in-place or windows-nt. windows-nt equivalent of --srcdir is
|
|
83 ;; BUILD_DIR in config.inc, and has no lisp/ or etc/ since symlinks
|
|
84 ;; don't exist. instead, xemacs.mak points configure-lisp-directory and
|
|
85 ;; configure-data-directory at the right places.
|
|
86 (and
|
1526
|
87 (or configure-exec-directory (paths-file-readable-directory-p (paths-construct-path (list directory "lib-src"))) (eq system-type 'windows-nt))
|
1330
|
88 (or configure-lisp-directory (paths-file-readable-directory-p (paths-construct-path (list directory "lisp"))))
|
|
89 (or configure-data-directory (paths-file-readable-directory-p (paths-construct-path (list directory "etc")))))))
|
|
90
|
|
91 (defun paths-emacs-data-root-p (directory)
|
|
92 "Check if DIRECTORY is a plausible data installation root.
|
|
93 A data installation root is one containing data files that may be shared
|
2456
|
94 among multiple different versions of XEmacs, the packages in particular.
|
|
95 This serves as an additional filter to narrow down the list of plausible
|
|
96 installation roots."
|
1330
|
97 (or
|
|
98 ;; installed
|
|
99 (paths-file-readable-directory-p (paths-construct-path (list directory
|
4154
|
100 "share"
|
1330
|
101 emacs-program-name)))
|
|
102 (paths-file-readable-directory-p (paths-construct-path (list directory
|
4154
|
103 "share"
|
1330
|
104 (construct-emacs-version-name))))
|
|
105 ;; in-place or windows-nt
|
|
106 (and
|
|
107 (paths-file-readable-directory-p (paths-construct-path (list directory "lisp")))
|
3281
|
108 (paths-file-readable-directory-p (paths-construct-path (list directory "etc"))))
|
1330
|
109
|
3281
|
110 ;; searching for a package directory
|
|
111 (and
|
|
112 (string-match "win32" system-configuration)
|
|
113 (paths-file-readable-directory-p (paths-construct-path (list directory
|
|
114 "xemacs-packages"))))))
|
|
115
|
|
116 (defun paths-find-invocation-roots (invocation-directory invocation-name root-p)
|
|
117 "Find the list of run-time roots of XEmacs.
|
2456
|
118 INVOCATION-DIRECTORY is a directory containing the XEmacs executable.
|
3281
|
119 INVOCATION-NAME is the name of the executable itself
|
|
120 ROOT-P is a function that tests whether a root is plausible."
|
1330
|
121 (let* ((executable-file-name (paths-chase-symlink
|
|
122 (concat invocation-directory
|
|
123 invocation-name)))
|
|
124 (executable-directory (file-name-directory executable-file-name))
|
|
125 (maybe-root-1 (file-name-as-directory
|
|
126 (paths-construct-path '("..") executable-directory)))
|
|
127 (maybe-root-2 (file-name-as-directory
|
|
128 (paths-construct-path '(".." "..") executable-directory))))
|
3281
|
129
|
|
130 (paths-filter root-p
|
|
131 (list maybe-root-1 maybe-root-2))))
|
1330
|
132
|
2456
|
133 (defun paths-find-emacs-roots (invocation-directory
|
|
134 invocation-name
|
|
135 root-p)
|
1330
|
136 "Find all plausible installation roots for XEmacs.
|
|
137 This is a list of plausible directories in which to search for the important
|
|
138 directories used by XEmacs at run-time, for example `exec-directory',
|
|
139 `data-directory' and `lisp-directory'.
|
|
140 ROOT-P is a function that tests whether a root is plausible."
|
3281
|
141 (let* ((invocation-roots
|
|
142 (paths-find-invocation-roots invocation-directory
|
|
143 invocation-name
|
|
144 root-p))
|
1330
|
145 (potential-installation-roots
|
|
146 (paths-uniq-append
|
|
147 (and configure-exec-prefix-directory
|
|
148 (list (file-name-as-directory
|
|
149 configure-exec-prefix-directory)))
|
|
150 (and configure-prefix-directory
|
|
151 (list (file-name-as-directory
|
|
152 configure-prefix-directory)))))
|
|
153 (installation-roots
|
|
154 (paths-filter root-p potential-installation-roots)))
|
|
155 (paths-uniq-append invocation-roots
|
|
156 installation-roots)))
|
|
157
|
428
|
158 (defun paths-find-site-lisp-directory (roots)
|
2456
|
159 "Find the site Lisp directory of the XEmacs hierarchy.
|
|
160 ROOTS is a list of installation roots."
|
4108
|
161 (paths-find-site-directory roots (list "site-lisp")
|
4092
|
162 nil nil
|
428
|
163 configure-site-directory))
|
|
164
|
|
165 (defun paths-find-site-module-directory (roots)
|
2456
|
166 "Find the site modules directory of the XEmacs hierarchy.
|
|
167 ROOTS is a list of installation roots."
|
4108
|
168 (paths-find-site-directory roots (list "site-modules")
|
4092
|
169 t nil
|
428
|
170 configure-site-module-directory))
|
|
171
|
|
172 (defun paths-find-lisp-directory (roots)
|
2456
|
173 "Find the main Lisp directory of the XEmacs hierarchy.
|
|
174 ROOTS is a list of installation roots."
|
4108
|
175 (paths-find-version-directory roots (list "lisp")
|
4092
|
176 nil nil
|
428
|
177 configure-lisp-directory))
|
|
178
|
460
|
179 (defun paths-find-mule-lisp-directory (roots &optional lisp-directory)
|
2456
|
180 "Find the Mule Lisp directory of the XEmacs hierarchy.
|
|
181 ROOTS is a list of installation roots."
|
460
|
182 ;; #### kludge
|
|
183 (if lisp-directory
|
|
184 (let ((guess
|
|
185 (file-name-as-directory
|
|
186 (paths-construct-path (list lisp-directory "mule")))))
|
|
187 (if (paths-file-readable-directory-p guess)
|
|
188 guess
|
4108
|
189 (paths-find-version-directory roots (list "mule-lisp")
|
4092
|
190 nil nil
|
460
|
191 configure-mule-lisp-directory)))))
|
|
192
|
428
|
193 (defun paths-find-module-directory (roots)
|
2456
|
194 "Find the main modules directory of the XEmacs hierarchy.
|
|
195 ROOTS is a list of installation roots."
|
4108
|
196 (paths-find-architecture-directory roots (list "modules")
|
428
|
197 nil configure-module-directory))
|
|
198
|
|
199 (defun paths-construct-load-path
|
|
200 (roots early-package-load-path late-package-load-path last-package-load-path
|
|
201 lisp-directory
|
460
|
202 &optional site-lisp-directory mule-lisp-directory)
|
2456
|
203 "Construct the complete load path.
|
|
204 ROOTS is the list of installation roots.
|
|
205 EARLY-PACKAGE-LOAD-PATH, LATE-PACKAGE-LOAD-PATH, and LAST-PACKAGE-LOAD-PATH
|
|
206 are the load paths for the package hierarchies.
|
|
207 SITE-LISP-DIRECTORY and MULE-LISP-DIRECTORY are optional directories to be
|
|
208 included in the load path---SITE-LISP-DIRECTORY for the obsolete site-specific
|
|
209 Lisp files, and MULE-LISP-DIRECTORY for the Mule Lisp files, which exist
|
|
210 only in Mule installations."
|
428
|
211 (let* ((envvar-value (getenv "EMACSLOADPATH"))
|
|
212 (env-load-path
|
|
213 (and envvar-value
|
|
214 (paths-decode-directory-path envvar-value 'drop-empties)))
|
|
215 (site-lisp-load-path
|
|
216 (and site-lisp-directory
|
|
217 (paths-find-recursive-load-path (list site-lisp-directory)
|
452
|
218 paths-site-load-path-depth)))
|
460
|
219 (mule-lisp-load-path
|
|
220 (and mule-lisp-directory
|
|
221 (paths-find-recursive-load-path (list mule-lisp-directory)
|
|
222 paths-mule-load-path-depth)))
|
428
|
223 (lisp-load-path
|
|
224 (and lisp-directory
|
|
225 (paths-find-recursive-load-path (list lisp-directory)
|
452
|
226 paths-core-load-path-depth))))
|
428
|
227 (append env-load-path
|
|
228 early-package-load-path
|
|
229 site-lisp-load-path
|
|
230 late-package-load-path
|
460
|
231 mule-lisp-load-path
|
428
|
232 lisp-load-path
|
|
233 last-package-load-path)))
|
|
234
|
|
235 (defun paths-construct-module-load-path
|
|
236 (root module-directory &optional site-module-directory)
|
|
237 "Construct the modules load path."
|
|
238 (let* ((envvar-value (getenv "EMACSMODULEPATH"))
|
|
239 (env-module-path
|
|
240 (and envvar-value
|
|
241 (paths-decode-directory-path envvar-value 'drop-empties)))
|
|
242 (site-module-load-path
|
|
243 (and site-module-directory
|
|
244 (paths-find-recursive-load-path (list site-module-directory)
|
452
|
245 paths-site-load-path-depth)))
|
428
|
246 (module-load-path
|
|
247 (and module-directory
|
|
248 (paths-find-recursive-load-path (list module-directory)
|
3813
|
249 paths-module-load-path-depth))))
|
2456
|
250 (append env-module-path
|
428
|
251 site-module-load-path
|
|
252 module-load-path)))
|
|
253
|
2456
|
254 (defun paths-construct-info-path (roots
|
|
255 early-package-hierarchies
|
|
256 late-package-hierarchies
|
|
257 last-package-hierarchies)
|
|
258 "Construct the info path.
|
|
259 ROOTS is the list of installation roots.
|
|
260 EARLY-PACKAGE-HIERARCHIES, LATE-PACKAGE-HIERARCHIES, and
|
|
261 LAST-PACKAGE-HIERARCHIES are lists of package hierarchy roots,
|
|
262 respectively."
|
428
|
263 (let ((info-path-envval (getenv "INFOPATH")))
|
|
264 (paths-uniq-append
|
|
265 (append
|
|
266 (let ((info-directory
|
4108
|
267 (paths-find-version-directory roots (list "info")
|
4092
|
268 nil nil
|
428
|
269 configure-info-directory)))
|
|
270 (and info-directory
|
|
271 (list info-directory)))
|
2456
|
272 (packages-find-package-info-path early-package-hierarchies)
|
|
273 (packages-find-package-info-path late-package-hierarchies)
|
|
274 (packages-find-package-info-path last-package-hierarchies)
|
428
|
275 (and info-path-envval
|
|
276 (paths-decode-directory-path info-path-envval 'drop-empties)))
|
|
277 (and (null info-path-envval)
|
|
278 (paths-uniq-append
|
|
279 (paths-directories-which-exist configure-info-path)
|
|
280 (paths-directories-which-exist paths-default-info-directories))))))
|
|
281
|
|
282 (defun paths-find-doc-directory (roots)
|
2456
|
283 "Find the documentation directory.
|
|
284 ROOTS is the list of installation roots."
|
4108
|
285 (paths-find-architecture-directory roots (list "lib-src") nil configure-doc-directory))
|
428
|
286
|
|
287 (defun paths-find-exec-directory (roots)
|
2456
|
288 "Find the binary directory.
|
|
289 ROOTS is the list of installation roots."
|
4108
|
290 (paths-find-architecture-directory roots (list "lib-src")
|
428
|
291 nil configure-exec-directory))
|
|
292
|
|
293 (defun paths-construct-exec-path (roots exec-directory
|
2456
|
294 early-package-hierarchies
|
|
295 late-package-hierarchies
|
|
296 last-package-hierarchies)
|
|
297 "Find the binary path.
|
|
298 ROOTS is the list of installation roots.
|
|
299 EARLY-PACKAGE-HIERARCHIES, LATE-PACKAGE-HIERARCHIES, and
|
|
300 LAST-PACKAGE-HIERARCHIES are lists of package hierarchy roots,
|
|
301 respectively.
|
|
302 EXEC-DIRECTORY is the directory of architecture-dependent files that
|
|
303 come with XEmacs.
|
|
304 EARLY-PACKAGES, LATE-PACKAGES, and LAST-PACKAGES are lists of
|
|
305 package hierarchy roots, respectively."
|
428
|
306 (append
|
|
307 (let ((path-envval (getenv "PATH")))
|
|
308 (if path-envval
|
|
309 (paths-decode-directory-path path-envval 'drop-empties)))
|
2456
|
310 (packages-find-package-exec-path early-package-hierarchies)
|
|
311 (packages-find-package-exec-path late-package-hierarchies)
|
428
|
312 (let ((emacspath-envval (getenv "EMACSPATH")))
|
|
313 (and emacspath-envval
|
|
314 (split-path emacspath-envval)))
|
|
315 (and exec-directory
|
|
316 (list exec-directory))
|
2456
|
317 (packages-find-package-exec-path last-package-hierarchies)))
|
428
|
318
|
|
319 (defun paths-find-data-directory (roots)
|
2456
|
320 "Find the data directory.
|
|
321 ROOTS is the list of installation roots."
|
4108
|
322 (paths-find-version-directory roots (list "etc") nil "EMACSDATA" configure-data-directory))
|
428
|
323
|
|
324 (defun paths-construct-data-directory-list (data-directory
|
2456
|
325 early-package-hierarchies
|
|
326 late-package-hierarchies
|
|
327 last-package-hierarchies)
|
|
328 "Construct the data path.
|
|
329 DATA-DIRECTORY is the data directory of the XEmacs installation.
|
|
330 EARLY-PACKAGE-HIERARCHIES, LATE-PACKAGE-HIERARCHIES, and
|
|
331 LAST-PACKAGE-HIERARCHIES are lists of package hierarchy roots,
|
|
332 respectively."
|
428
|
333 (append
|
2456
|
334 (packages-find-package-data-path early-package-hierarchies)
|
|
335 (packages-find-package-data-path late-package-hierarchies)
|
428
|
336 (list data-directory)
|
2456
|
337 (packages-find-package-data-path last-package-hierarchies)))
|
1330
|
338
|
428
|
339 ;;; setup-paths.el ends here
|