find-system.lisp 16.6 KB
Newer Older
1
2
3
;;;; -------------------------------------------------------------------------
;;;; Finding systems

4
5
(asdf/package:define-package :asdf/find-system
  (:recycle :asdf/find-system :asdf)
6
  (:use :common-lisp :asdf/driver :asdf/upgrade :asdf/component :asdf/system)
7
  (:export
8
   #:remove-entry-from-registry #:coerce-entry-to-directory
9
10
   #:coerce-name #:primary-system-name
   #:find-system #:locate-system #:load-sysdef #:with-system-definitions
11
12
13
14
15
16
17
   #:system-registered-p #:register-system #:registered-systems #:clear-system #:map-systems
   #:system-definition-error #:missing-component #:missing-requires #:missing-parent
   #:formatted-system-definition-error #:format-control #:format-arguments #:sysdef-error
   #:load-system-definition-error #:error-name #:error-pathname #:error-condition
   #:*system-definition-search-functions* #:search-for-system-definition
   #:*central-registry* #:probe-asd #:sysdef-central-registry-search
   #:make-temporary-package #:find-system-if-being-defined #:*systems-being-defined*
18
19
   #:find-system-fallback #:sysdef-find-asdf #:contrib-sysdef-search
   #:system-find-pre-loaded-system #:*pre-loaded-systems*
20
21
22
23
24
   #:make-defined-systems-table #:*defined-systems*
   ;; defined in source-registry, but specially mentioned here:
   #:initialize-source-registry #:sysdef-source-registry-search))
(in-package :asdf/find-system)

25
(declaim (ftype (function (&optional t) t) initialize-source-registry)) ; forward reference
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

(define-condition system-definition-error (error) ()
  ;; [this use of :report should be redundant, but unfortunately it's not.
  ;; cmucl's lisp::output-instance prefers the kernel:slot-class-print-function
  ;; over print-object; this is always conditions::%print-condition for
  ;; condition objects, which in turn does inheritance of :report options at
  ;; run-time.  fortunately, inheritance means we only need this kludge here in
  ;; order to fix all conditions that build on it.  -- rgr, 28-Jul-02.]
  #+cmu (:report print-object))

(define-condition missing-component (system-definition-error)
  ((requires :initform "(unnamed)" :reader missing-requires :initarg :requires)
   (parent :initform nil :reader missing-parent :initarg :parent)))

(define-condition formatted-system-definition-error (system-definition-error)
  ((format-control :initarg :format-control :reader format-control)
   (format-arguments :initarg :format-arguments :reader format-arguments))
  (:report (lambda (c s)
               (apply 'format s (format-control c) (format-arguments c)))))

(define-condition load-system-definition-error (system-definition-error)
  ((name :initarg :name :reader error-name)
   (pathname :initarg :pathname :reader error-pathname)
   (condition :initarg :condition :reader error-condition))
  (:report (lambda (c s)
             (format s (compatfmt "~@<Error while trying to load definition for system ~A from pathname ~A: ~3i~_~A~@:>")
                     (error-name c) (error-pathname c) (error-condition c)))))

(defun* sysdef-error (format &rest arguments)
  (error 'formatted-system-definition-error :format-control
         format :format-arguments arguments))

(defun* make-defined-systems-table ()
  (make-hash-table :test 'equal))

(defvar *defined-systems* (make-defined-systems-table)
  "This is a hash table whose keys are strings, being the
names of the systems, and whose values are pairs, the first
element of which is a universal-time indicating when the
system definition was last updated, and the second element
of which is a system object.")

(defun* coerce-name (name)
  (typecase name
    (component (component-name name))
    (symbol (string-downcase (symbol-name name)))
    (string name)
    (t (sysdef-error (compatfmt "~@<Invalid component designator: ~3i~_~A~@:>") name))))

75
76
77
78
79
(defun* primary-system-name (name)
  ;; When a system name has slashes, the file with defsystem is named by
  ;; the first of the slash-separated components.
  (first (split-string (coerce-name name) :separator "/")))

80
81
82
83
84
85
86
87
88
89
90
91
92
93
(defun* system-registered-p (name)
  (gethash (coerce-name name) *defined-systems*))

(defun* registered-systems ()
  (loop :for (() . system) :being :the :hash-values :of *defined-systems*
    :collect (coerce-name system)))

(defun* register-system (system)
  (check-type system system)
  (let ((name (component-name system)))
    (check-type name string)
    (asdf-message (compatfmt "~&~@<; ~@;Registering ~3i~_~A~@:>~%") system)
    (unless (eq system (cdr (gethash name *defined-systems*)))
      (setf (gethash name *defined-systems*)
94
            (cons (if-let (file (ignore-errors (system-source-file system)))
95
96
                    (safe-file-write-date file))
                  system)))))
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

(defun* clear-system (name)
  "Clear the entry for a system in the database of systems previously loaded.
Note that this does NOT in any way cause the code of the system to be unloaded."
  ;; There is no "unload" operation in Common Lisp, and
  ;; a general such operation cannot be portably written,
  ;; considering how much CL relies on side-effects to global data structures.
  (remhash (coerce-name name) *defined-systems*))

(defun* map-systems (fn)
  "Apply FN to each defined system.

FN should be a function of one argument. It will be
called with an object of type asdf:system."
  (loop :for (nil . system) :being :the hash-values :of *defined-systems*
        :do (funcall fn system)))

;;; for the sake of keeping things reasonably neat, we adopt a
;;; convention that functions in this list are prefixed SYSDEF-

(defvar *system-definition-search-functions* '())

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
(defun cleanup-system-definition-search-functions ()
  (setf *system-definition-search-functions*
        (append
         ;; Remove known-incompatible sysdef functions from old versions of asdf.
         (remove-if #'(lambda (x) (member x '(contrib-sysdef-search sysdef-find-asdf)))
                    *system-definition-search-functions*)
         ;; Tuck our defaults at the end of the list if they were absent.
         ;; This is imperfect, in case they were removed on purpose,
         ;; but then it will be the responsibility of whoever does that
         ;; to upgrade asdf before he does such a thing rather than after.
         (remove-if #'(lambda (x) (member x *system-definition-search-functions*))
                    '(sysdef-central-registry-search
                      sysdef-source-registry-search
                      sysdef-find-pre-loaded-systems)))))
(cleanup-system-definition-search-functions)
134
135

(defun* search-for-system-definition (system)
136
137
138
  (some (let ((name (coerce-name system))) #'(lambda (x) (funcall x name)))
        (cons 'find-system-if-being-defined
              *system-definition-search-functions*)))
139
140
141
142
143
144
145
146
147
148
149
150

(defvar *central-registry* nil
"A list of 'system directory designators' ASDF uses to find systems.

A 'system directory designator' is a pathname or an expression
which evaluates to a pathname. For example:

    (setf asdf:*central-registry*
          (list '*default-pathname-defaults*
                #p\"/home/me/cl/systems/\"
                #p\"/usr/share/common-lisp/systems/\"))

151
This is for backward compatibility.
152
153
154
Going forward, we recommend new users should be using the source-registry.
")

155
(defun* probe-asd (name defaults &key truename)
156
157
  (block nil
    (when (directory-pathname-p defaults)
158
159
160
      (let* ((file (probe-file*
                    (absolutize-pathnames
                     (list (make-pathname :name name :type "asd")
161
162
                           defaults *default-pathname-defaults*
                           #-(or abcl gcl genera) (getcwd))
163
164
                     :resolve-symlinks truename)
                    :truename truename)))
165
166
167
168
169
170
        (when file
          (return file)))
      #-(or clisp genera) ; clisp doesn't need it, plain genera doesn't have read-sequence(!)
      (when (os-windows-p)
        (let ((shortcut
               (make-pathname
171
                :defaults defaults :case :local
172
173
174
175
176
177
178
179
                :name (strcat name ".asd")
                :type "lnk")))
          (when (probe-file* shortcut)
            (let ((target (parse-windows-shortcut shortcut)))
              (when target
                (return (pathname target))))))))))

(defun* sysdef-central-registry-search (system)
180
  (let ((name (primary-system-name system))
181
182
183
184
185
        (to-remove nil)
        (to-replace nil))
    (block nil
      (unwind-protect
           (dolist (dir *central-registry*)
186
187
             (let ((defaults (eval dir))
                   directorized)
188
               (when defaults
189
                 (cond ((directory-pathname-p defaults)
190
                        (let* ((file (probe-asd name defaults :truename *resolve-symlinks*)))
191
192
193
194
195
196
197
                          (when file
                            (return file))))
                       (t
                        (restart-case
                            (let* ((*print-circle* nil)
                                   (message
                                    (format nil
198
                                            (compatfmt "~@<While searching for system ~S: ~3i~_~S evaluated to ~S which is not an absolute directory.~@:>")
199
200
201
202
203
204
                                            system dir defaults)))
                              (error message))
                          (remove-entry-from-registry ()
                            :report "Remove entry from *central-registry* and continue"
                            (push dir to-remove))
                          (coerce-entry-to-directory ()
205
206
207
208
209
                            :test (lambda (c) (declare (ignore c))
                                    (and (not (directory-pathname-p defaults))
                                         (directory-pathname-p
                                          (setf directorized
                                                (ensure-directory-pathname defaults)))))
210
211
                            :report (lambda (s)
                                      (format s (compatfmt "~@<Coerce entry to ~a, replace ~a and continue.~@:>")
212
213
                                              directorized dir))
                            (push (cons dir directorized) to-replace))))))))
214
215
216
217
218
219
220
221
222
223
224
225
226
        ;; cleanup
        (dolist (dir to-remove)
          (setf *central-registry* (remove dir *central-registry*)))
        (dolist (pair to-replace)
          (let* ((current (car pair))
                 (new (cdr pair))
                 (position (position current *central-registry*)))
            (setf *central-registry*
                  (append (subseq *central-registry* 0 position)
                          (list new)
                          (subseq *central-registry* (1+ position))))))))))

(defun* make-temporary-package ()
227
  (make-package (fresh-package-name :asdf 0) :use '(:cl :asdf/interface)))
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

(defmethod find-system ((name null) &optional (error-p t))
  (declare (ignorable name))
  (when error-p
    (sysdef-error (compatfmt "~@<NIL is not a valid system name~@:>"))))

(defmethod find-system (name &optional (error-p t))
  (find-system (coerce-name name) error-p))

(defvar *systems-being-defined* nil
  "A hash-table of systems currently being defined keyed by name, or NIL")

(defun* find-system-if-being-defined (name)
  (when *systems-being-defined*
    (gethash (coerce-name name) *systems-being-defined*)))

(defun* call-with-system-definitions (thunk)
  (if *systems-being-defined*
      (funcall thunk)
      (let ((*systems-being-defined* (make-hash-table :test 'equal)))
        (funcall thunk))))

(defmacro with-system-definitions ((&optional) &body body)
  `(call-with-system-definitions #'(lambda () ,@body)))

(defun* load-sysdef (name pathname)
  ;; Tries to load system definition with canonical NAME from PATHNAME.
  (with-system-definitions ()
256
    (let ((package (make-temporary-package))) ;; ASDF3: get rid of that.
257
258
259
260
261
262
263
264
265
266
267
268
269
      (unwind-protect
           (handler-bind
               ((error #'(lambda (condition)
                           (error 'load-system-definition-error
                                  :name name :pathname pathname
                                  :condition condition))))
             (let ((*package* package)
                   (*default-pathname-defaults*
                    ;; resolve logical-pathnames so they won't wreak havoc in parsing namestrings.
                    (pathname-directory-pathname (translate-logical-pathname pathname)))
                   (external-format (encoding-external-format (detect-encoding pathname))))
               (asdf-message (compatfmt "~&~@<; ~@;Loading system definition from ~A into ~A~@:>~%")
                             pathname package)
270
               (with-muffled-loader-conditions ()
271
                 (load* pathname :external-format external-format))))
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
        (delete-package package)))))

(defun* locate-system (name)
  "Given a system NAME designator, try to locate where to load the system from.
Returns five values: FOUNDP FOUND-SYSTEM PATHNAME PREVIOUS PREVIOUS-TIME
FOUNDP is true when a system was found,
either a new unregistered one or a previously registered one.
FOUND-SYSTEM when not null is a SYSTEM object that may be REGISTER-SYSTEM'ed as is
PATHNAME when not null is a path from where to load the system,
either associated with FOUND-SYSTEM, or with the PREVIOUS system.
PREVIOUS when not null is a previously loaded SYSTEM object of same name.
PREVIOUS-TIME when not null is the time at which the PREVIOUS system was loaded."
  (let* ((name (coerce-name name))
         (in-memory (system-registered-p name)) ; load from disk if absent or newer on disk
         (previous (cdr in-memory))
         (previous (and (typep previous 'system) previous))
         (previous-time (car in-memory))
         (found (search-for-system-definition name))
         (found-system (and (typep found 'system) found))
         (pathname (or (and (typep found '(or pathname string)) (pathname found))
                       (and found-system (system-source-file found-system))
                       (and previous (system-source-file previous))))
294
         (pathname (ensure-pathname (resolve-symlinks* pathname) :want-absolute t))
295
296
         (foundp (and (or found-system pathname previous) t)))
    (check-type found (or null pathname system))
297
298
    (values foundp found-system pathname previous previous-time)))

299
300
301
302
303
304
(defmethod find-system ((name string) &optional (error-p t))
  (with-system-definitions ()
    (loop
      (restart-case
          (multiple-value-bind (foundp found-system pathname previous previous-time)
              (locate-system name)
305
            (assert (eq foundp (and (or found-system pathname previous) t)))
306
307
308
309
310
311
312
313
            (let ((previous-pathname (and previous (system-source-file previous)))
                  (system (or previous found-system)))
              (when (and found-system (not previous))
                (register-system found-system))
              (when (and system pathname)
                (setf (system-source-file system) pathname))
              (when (and pathname
                         (not (and previous
314
315
316
317
318
                                   (or (pathname-equal pathname previous-pathname)
                                       (and pathname previous-pathname
                                            (pathname-equal
                                             (translate-logical-pathname pathname)
                                             (translate-logical-pathname previous-pathname))))
319
320
321
                                   (stamp<= (safe-file-write-date pathname) previous-time))))
                ;; only load when it's a pathname that is different or has newer content
                (load-sysdef name pathname)))
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
            (let ((in-memory (system-registered-p name))) ; try again after loading from disk if needed
              (return
                (cond
                  (in-memory
                   (when pathname
                     (setf (car in-memory) (safe-file-write-date pathname)))
                   (cdr in-memory))
                  (error-p
                   (error 'missing-component :requires name))))))
        (reinitialize-source-registry-and-retry ()
          :report (lambda (s)
                    (format s (compatfmt "~@<Retry finding system ~A after reinitializing the source-registry.~@:>") name))
          (initialize-source-registry))))))

(defun* find-system-fallback (requested fallback &rest keys &key source-file &allow-other-keys)
  (setf fallback (coerce-name fallback)
        requested (coerce-name requested))
  (when (equal requested fallback)
    (let ((registered (cdr (gethash fallback *defined-systems*))))
      (or registered
342
          (apply 'make-instance 'system :name fallback :source-file source-file keys)))))
343

344
345
346
347
348
(defvar *pre-loaded-systems* `(("asdf") ("asdf-driver")))

(defun* sysdef-find-pre-loaded-systems (requested)
  (loop :for (provided . keys) :in *pre-loaded-systems*
        :thereis (apply 'find-system-fallback requested provided keys)))