|
428
|
1 ;;; find-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.org>
|
|
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 basic library functionality for manipulating paths
|
|
|
36 ;; and path lists and finding paths in the XEmacs hierarchy.
|
|
|
37
|
|
428
|
38
|
|
|
39 ;;; Code:
|
|
|
40
|
|
|
41 (defvar paths-version-control-filename-regexp
|
|
|
42 "^\\(RCS\\|CVS\\|SCCS\\)$"
|
|
|
43 "File bases associated with version control.")
|
|
|
44
|
|
|
45 (defvar paths-lisp-filename-regexp
|
|
|
46 "^\\(.*\\.elc?\\)$"
|
|
2297
|
47 "File bases that name Emacs Lisp files.")
|
|
428
|
48
|
|
|
49 (defvar paths-no-lisp-directory-regexp
|
|
|
50 (concat "\\(" paths-version-control-filename-regexp "\\)"
|
|
|
51 "\\|"
|
|
|
52 "\\(" paths-lisp-filename-regexp "\\)")
|
|
|
53 "File bases that may not be directories containing Lisp code.")
|
|
|
54
|
|
|
55 (defun paths-find-recursive-path (directories &optional max-depth exclude-regexp)
|
|
|
56 "Return a list of the directory hierarchy underneath DIRECTORIES.
|
|
|
57 The returned list is sorted by pre-order and lexicographically.
|
|
|
58 MAX-DEPTH limits the depth of the search to MAX-DEPTH level,
|
|
|
59 if it is a number. If MAX-DEPTH is NIL, the search depth is unlimited.
|
|
|
60 EXCLUDE-REGEXP is a regexp that matches directory names to exclude
|
|
|
61 from the search."
|
|
|
62 (let ((path '()))
|
|
|
63 (while directories
|
|
|
64 (let ((directory (file-name-as-directory
|
|
|
65 (expand-file-name
|
|
|
66 (car directories)))))
|
|
|
67 (if (paths-file-readable-directory-p directory)
|
|
|
68 (let ((raw-entries
|
|
|
69 (if (equal 0 max-depth)
|
|
|
70 '()
|
|
|
71 (directory-files directory nil "^[^.-]")))
|
|
|
72 (reverse-dirs '()))
|
|
|
73 (while raw-entries
|
|
531
|
74 (if (not (and exclude-regexp
|
|
|
75 (string-match exclude-regexp (car raw-entries))))
|
|
428
|
76 (setq reverse-dirs
|
|
|
77 (cons (expand-file-name (car raw-entries) directory)
|
|
|
78 reverse-dirs)))
|
|
|
79 (setq raw-entries (cdr raw-entries)))
|
|
|
80
|
|
|
81 (let ((sub-path
|
|
|
82 (paths-find-recursive-path (reverse reverse-dirs)
|
|
|
83 (if (numberp max-depth)
|
|
|
84 (- max-depth 1)
|
|
|
85 max-depth)
|
|
|
86 exclude-regexp)))
|
|
|
87 (setq path (nconc path
|
|
|
88 (list directory)
|
|
|
89 sub-path))))))
|
|
|
90 (setq directories (cdr directories)))
|
|
|
91 path))
|
|
|
92
|
|
|
93 (defun paths-file-readable-directory-p (filename)
|
|
|
94 "Check if filename is a readable directory."
|
|
|
95 (and (file-directory-p filename)
|
|
|
96 (file-readable-p filename)))
|
|
|
97
|
|
|
98 (defun paths-find-recursive-load-path (directories &optional max-depth)
|
|
|
99 "Construct a recursive load path underneath DIRECTORIES."
|
|
|
100 (paths-find-recursive-path directories
|
|
|
101 max-depth paths-no-lisp-directory-regexp))
|
|
|
102
|
|
|
103 (defun paths-chase-symlink (file-name)
|
|
|
104 "Chase a symlink until the bitter end."
|
|
|
105 (let ((maybe-symlink (file-symlink-p file-name)))
|
|
|
106 (if maybe-symlink
|
|
|
107 (let* ((directory (file-name-directory file-name))
|
|
|
108 (destination (expand-file-name maybe-symlink directory)))
|
|
|
109 (paths-chase-symlink destination))
|
|
|
110 file-name)))
|
|
|
111
|
|
|
112 (defun paths-construct-path (components &optional expand-directory)
|
|
|
113 "Convert list of path components COMPONENTS into a path.
|
|
|
114 If EXPAND-DIRECTORY is non-NIL, use it as a directory to feed
|
|
|
115 to EXPAND-FILE-NAME."
|
|
|
116 (let* ((reverse-components (reverse components))
|
|
|
117 (last-component (car reverse-components))
|
|
|
118 (first-components (reverse (cdr reverse-components)))
|
|
|
119 (path
|
|
|
120 (apply #'concat
|
|
|
121 (append (mapcar #'file-name-as-directory first-components)
|
|
|
122 (list last-component)))))
|
|
|
123 (if expand-directory
|
|
|
124 (expand-file-name path expand-directory)
|
|
|
125 path)))
|
|
|
126
|
|
|
127 (defun paths-construct-emacs-directory (root suffix base)
|
|
2456
|
128 "Construct a directory name within the XEmacs hierarchy.
|
|
3753
|
129 ROOT must be an installation root.
|
|
2456
|
130 SUFFIX is the subdirectory from there.
|
|
|
131 BASE is the base to look for."
|
|
428
|
132 (file-name-as-directory
|
|
|
133 (expand-file-name
|
|
|
134 (concat
|
|
|
135 (file-name-as-directory root)
|
|
|
136 suffix
|
|
|
137 base))))
|
|
|
138
|
|
2481
|
139
|
|
|
140 (defun paths-for-each-emacs-directory (func
|
|
|
141 roots suffix base
|
|
|
142 &optional envvar default keep-suffix)
|
|
|
143 "Iterate over directories in the XEmacs hierarchy.
|
|
|
144 FUNC is a function that called for each directory, with the directory
|
|
|
145 as the only argument.
|
|
428
|
146 ROOTS must be a list of installation roots.
|
|
|
147 SUFFIX is the subdirectory from there.
|
|
|
148 BASE is the base to look for.
|
|
|
149 ENVVAR is the name of the environment variable that might also
|
|
|
150 specify the directory.
|
|
|
151 DEFAULT is the preferred value.
|
|
|
152 If KEEP-SUFFIX is non-nil, the suffix must be respected in searching
|
|
1218
|
153 the directory."
|
|
428
|
154 (let ((preferred-value (or (and envvar (getenv envvar))
|
|
|
155 default)))
|
|
|
156 (if (and preferred-value
|
|
|
157 (paths-file-readable-directory-p preferred-value))
|
|
|
158 (file-name-as-directory preferred-value)
|
|
2481
|
159 (while roots
|
|
|
160 (let* ((root (car roots))
|
|
|
161 ;; installed
|
|
|
162 (path (paths-construct-emacs-directory root suffix base)))
|
|
|
163 (if (paths-file-readable-directory-p path)
|
|
|
164 (funcall func path)
|
|
|
165 ;; in-place
|
|
|
166 (if (null keep-suffix)
|
|
|
167 (let ((path (paths-construct-emacs-directory root "" base)))
|
|
|
168 (if (paths-file-readable-directory-p path)
|
|
|
169 (funcall func path))))))
|
|
|
170 (setq roots (cdr roots))))))
|
|
|
171
|
|
|
172 (defun paths-find-emacs-directories (roots
|
|
|
173 suffix base
|
|
|
174 &optional envvar default keep-suffix)
|
|
|
175 "Find a list of directories in the XEmacs hierarchy.
|
|
|
176 ROOTS must be a list of installation roots.
|
|
|
177 SUFFIX is the subdirectory from there.
|
|
|
178 BASE is the base to look for.
|
|
|
179 ENVVAR is the name of the environment variable that might also
|
|
|
180 specify the directory.
|
|
|
181 DEFAULT is the preferred value.
|
|
|
182 If KEEP-SUFFIX is non-nil, the suffix must be respected in searching
|
|
|
183 the directory."
|
|
|
184 (let ((l '()))
|
|
|
185 (paths-for-each-emacs-directory #'(lambda (dir)
|
|
|
186 (setq l (cons dir l)))
|
|
|
187 roots
|
|
|
188 suffix base
|
|
|
189 envvar default keep-suffix)
|
|
|
190 (reverse l)))
|
|
|
191
|
|
|
192 (defun paths-find-emacs-directory (roots suffix base
|
|
|
193 &optional envvar default keep-suffix)
|
|
|
194 "Find a directory in the XEmacs hierarchy.
|
|
|
195 ROOTS must be a list of installation roots.
|
|
|
196 SUFFIX is the subdirectory from there.
|
|
|
197 BASE is the base to look for.
|
|
|
198 ENVVAR is the name of the environment variable that might also
|
|
|
199 specify the directory.
|
|
|
200 DEFAULT is the preferred value.
|
|
|
201 If KEEP-SUFFIX is non-nil, the suffix must be respected in searching
|
|
|
202 the directory."
|
|
|
203 (catch 'gotcha
|
|
|
204 (paths-for-each-emacs-directory #'(lambda (dir)
|
|
|
205 (throw 'gotcha dir))
|
|
|
206 roots
|
|
|
207 suffix base
|
|
|
208 envvar default keep-suffix)))
|
|
|
209
|
|
|
210 (defun paths-for-each-site-directory (func roots base &optional envvar default)
|
|
|
211 "Iterate over the site-specific directories in the XEmacs hierarchy.
|
|
|
212 FUNC is a function that called for each directory, with the directory
|
|
|
213 as the only argument.
|
|
3753
|
214 ROOTS must be a list of installation roots.
|
|
2481
|
215 BASE is the base to look for.
|
|
|
216 ENVVAR is the name of the environment variable that might also
|
|
|
217 specify the directory.
|
|
|
218 DEFAULT is the preferred value."
|
|
|
219 (paths-for-each-emacs-directory func
|
|
|
220 roots
|
|
|
221 (file-name-as-directory
|
|
|
222 (paths-construct-path (list
|
|
|
223 "lib"
|
|
|
224 emacs-program-name)))
|
|
|
225 base
|
|
|
226 envvar default))
|
|
428
|
227
|
|
1218
|
228 (defun paths-find-site-directory (roots base &optional envvar default)
|
|
2456
|
229 "Find a site-specific directory in the XEmacs hierarchy.
|
|
3753
|
230 ROOTS must be a list of installation roots.
|
|
2456
|
231 BASE is the base to look for.
|
|
|
232 ENVVAR is the name of the environment variable that might also
|
|
|
233 specify the directory.
|
|
|
234 DEFAULT is the preferred value."
|
|
2481
|
235 (catch 'gotcha
|
|
|
236 (paths-for-each-site-directory #'(lambda (dir)
|
|
|
237 (throw 'gotcha dir))
|
|
|
238 roots base
|
|
|
239 envvar default)))
|
|
428
|
240
|
|
2481
|
241 (defun paths-find-site-directories (roots base &optional envvar default)
|
|
|
242 "Find a list of site-specific directories in the XEmacs hierarchy.
|
|
3753
|
243 ROOTS must be a list of installation roots.
|
|
2481
|
244 BASE is the base to look for.
|
|
|
245 ENVVAR is the name of the environment variable that might also
|
|
|
246 specify the directory.
|
|
|
247 DEFAULT is the preferred value."
|
|
|
248 (let ((l '()))
|
|
|
249 (paths-for-each-site-directory #'(lambda (dir)
|
|
|
250 (setq l (cons dir l)))
|
|
|
251 roots base
|
|
|
252 envvar default)
|
|
|
253 (reverse l)))
|
|
2456
|
254
|
|
2481
|
255 (defun paths-for-each-version-directory (func roots base
|
|
|
256 &optional envvar default enforce-version)
|
|
|
257 "Iterate over version-specific directories in the XEmacs hierarchy.
|
|
|
258 FUNC is a function that called for each directory, with the directory
|
|
|
259 as the only argument.
|
|
3753
|
260 ROOTS must be a list of installation roots.
|
|
2456
|
261 BASE is the base to look for.
|
|
|
262 ENVVAR is the name of the environment variable that might also
|
|
|
263 specify the directory.
|
|
|
264 DEFAULT is the preferred value.
|
|
428
|
265 If ENFORCE-VERSION is non-nil, the directory must contain the XEmacs version."
|
|
2481
|
266 (paths-for-each-emacs-directory func
|
|
|
267 roots
|
|
|
268 (file-name-as-directory
|
|
|
269 (paths-construct-path
|
|
|
270 (list "lib"
|
|
|
271 (construct-emacs-version-name))))
|
|
|
272 base
|
|
|
273 envvar default))
|
|
|
274
|
|
|
275 (defun paths-find-version-directory (roots base
|
|
|
276 &optional envvar default enforce-version)
|
|
|
277 "Find a version-specific directory in the XEmacs hierarchy.
|
|
3753
|
278 ROOTS must be a list of installation roots.
|
|
2481
|
279 BASE is the base to look for.
|
|
|
280 ENVVAR is the name of the environment variable that might also
|
|
|
281 specify the directory.
|
|
|
282 DEFAULT is the preferred value.
|
|
|
283 If ENFORCE-VERSION is non-nil, the directory must contain the XEmacs version."
|
|
|
284 (catch 'gotcha
|
|
|
285 (paths-for-each-version-directory #'(lambda (dir)
|
|
|
286 (throw 'gotcha dir))
|
|
|
287 roots base
|
|
|
288 envvar default)))
|
|
|
289
|
|
|
290 (defun paths-find-version-directories (roots base
|
|
|
291 &optional envvar default enforce-version)
|
|
|
292 "Find a list of version-specific directories in the XEmacs hierarchy.
|
|
3753
|
293 ROOTS must be a list of installation roots.
|
|
2481
|
294 BASE is the base to look for.
|
|
|
295 ENVVAR is the name of the environment variable that might also
|
|
|
296 specify the directory.
|
|
|
297 DEFAULT is the preferred value.
|
|
|
298 If ENFORCE-VERSION is non-nil, the directory must contain the XEmacs version."
|
|
|
299 (let ((l '()))
|
|
|
300 (paths-for-each-site-directory #'(lambda (dir)
|
|
|
301 (setq l (cons dir l)))
|
|
|
302 roots base
|
|
|
303 envvar default)
|
|
|
304 (reverse l)))
|
|
428
|
305
|
|
|
306 (defun paths-find-architecture-directory (roots base &optional envvar default)
|
|
2456
|
307 "Find an architecture-specific directory in the XEmacs hierarchy.
|
|
3753
|
308 ROOTS must be a list of installation roots.
|
|
2456
|
309 BASE is the base to look for.
|
|
|
310 ENVVAR is the name of the environment variable that might also
|
|
|
311 specify the directory.
|
|
|
312 DEFAULT is the preferred value."
|
|
428
|
313 (or
|
|
|
314 ;; from more to less specific
|
|
|
315 (paths-find-version-directory roots
|
|
865
|
316 (paths-construct-path
|
|
|
317 (list system-configuration base))
|
|
428
|
318 envvar default)
|
|
|
319 (paths-find-version-directory roots
|
|
|
320 base
|
|
|
321 envvar)
|
|
|
322 (paths-find-version-directory roots
|
|
|
323 system-configuration
|
|
|
324 envvar)))
|
|
|
325
|
|
|
326 (defun construct-emacs-version-name ()
|
|
2456
|
327 "Construct a string from the raw XEmacs version number."
|
|
428
|
328 (concat emacs-program-name "-" emacs-program-version))
|
|
|
329
|
|
|
330 (defun paths-directories-which-exist (directories)
|
|
2456
|
331 "Return the directories among DIRECTORIES.
|
|
|
332 DIRECTORIES is a list of strings."
|
|
428
|
333 (let ((reverse-directories '()))
|
|
|
334 (while directories
|
|
|
335 (if (paths-file-readable-directory-p (car directories))
|
|
|
336 (setq reverse-directories
|
|
|
337 (cons (car directories)
|
|
|
338 reverse-directories)))
|
|
|
339 (setq directories (cdr directories)))
|
|
|
340 (reverse reverse-directories)))
|
|
|
341
|
|
|
342 (defun paths-uniq-append (list-1 list-2)
|
|
2456
|
343 "Append LIST-1 and LIST-2, omitting EQUAL duplicates."
|
|
428
|
344 (let ((reverse-survivors '()))
|
|
|
345 (while list-2
|
|
|
346 (if (null (member (car list-2) list-1))
|
|
|
347 (setq reverse-survivors (cons (car list-2) reverse-survivors)))
|
|
|
348 (setq list-2 (cdr list-2)))
|
|
|
349 (append list-1
|
|
|
350 (reverse reverse-survivors))))
|
|
|
351
|
|
|
352 (defun paths-filter (predicate list)
|
|
|
353 "Delete all matches of PREDICATE from LIST."
|
|
|
354 (let ((reverse-result '()))
|
|
|
355 (while list
|
|
|
356 (if (funcall predicate (car list))
|
|
|
357 (setq reverse-result (cons (car list) reverse-result)))
|
|
|
358 (setq list (cdr list)))
|
|
|
359 (nreverse reverse-result)))
|
|
|
360
|
|
|
361 (defun paths-decode-directory-path (string &optional drop-empties)
|
|
|
362 "Split STRING at path separators into a directory list.
|
|
442
|
363 Non-\"\" components are converted into directory form.
|
|
428
|
364 If DROP-EMPTIES is non-NIL, \"\" components are dropped from the output.
|
|
|
365 Otherwise, they are left alone."
|
|
|
366 (let* ((components (split-path string))
|
|
|
367 (directories
|
|
|
368 (mapcar #'(lambda (component)
|
|
|
369 (if (string-equal "" component)
|
|
|
370 component
|
|
|
371 (file-name-as-directory component)))
|
|
|
372 components)))
|
|
|
373 (if drop-empties
|
|
|
374 (paths-filter #'(lambda (component)
|
|
|
375 (null (string-equal "" component)))
|
|
|
376 directories)
|
|
|
377 directories)))
|
|
|
378
|
|
|
379 ;;; find-paths.el ends here
|
