asdf.lisp 138 KB
Newer Older
1
;;; -*- mode: common-lisp; package: asdf; -*-
Francois-Rene Rideau's avatar
1.647:    
Francois-Rene Rideau committed
2
;;; This is ASDF: Another System Definition Facility.
3
;;;
4
5
;;; Feedback, bug reports, and patches are all welcome:
;;; please mail to <asdf-devel@common-lisp.net>.
Francois-Rene Rideau's avatar
1.647:    
Francois-Rene Rideau committed
6
;;; Note first that the canonical source for ASDF is presently
7
;;; <URL:http://common-lisp.net/project/asdf/>.
8
9
10
11
12
;;;
;;; If you obtained this copy from anywhere else, and you experience
;;; trouble using it, or find bugs, you may want to check at the
;;; location above for a more recent version (and for documentation
;;; and test files, if your copy came without them) before reporting
13
;;; bugs.  There are usually two "supported" revisions - the git HEAD
14
15
16
;;; is the latest development version, whereas the revision tagged
;;; RELEASE may be slightly older but is considered `stable'

17
;;; -- LICENSE START
18
;;; (This is the MIT / X Consortium license as taken from
19
20
21
;;;  http://www.opensource.org/licenses/mit-license.html on or about
;;;  Monday; July 13, 2009)
;;;
22
;;; Copyright (c) 2001-2010 Daniel Barlow and contributors
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
;;;
;;; Permission is hereby granted, free of charge, to any person obtaining
;;; a copy of this software and associated documentation files (the
;;; "Software"), to deal in the Software without restriction, including
;;; without limitation the rights to use, copy, modify, merge, publish,
;;; distribute, sublicense, and/or sell copies of the Software, and to
;;; permit persons to whom the Software is furnished to do so, subject to
;;; the following conditions:
;;;
;;; The above copyright notice and this permission notice shall be
;;; included in all copies or substantial portions of the Software.
;;;
;;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
;;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
;;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
;;; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
;;; LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
;;; OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
;;; WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42
43
;;;
;;; -- LICENSE END
44

45
46
;;; The problem with writing a defsystem replacement is bootstrapping:
;;; we can't use defsystem to compile it.  Hence, all in one file.
Daniel Barlow's avatar
Daniel Barlow committed
47

48
49
#+xcvb (module ())

50
51
52
(cl:in-package :cl)
(defpackage :asdf-bootstrap (:use :cl))
(in-package :asdf-bootstrap)
53

54
55
56
57
58
59
60
61
62
63
64
65
;; Implementation-dependent tweaks
(eval-when (:compile-toplevel :load-toplevel :execute)
  ;; (declaim (optimize (speed 2) (debug 2) (safety 3)) ; NO: rely on the implementation defaults.
  #+allegro
  (setf excl::*autoload-package-name-alist*
        (remove "asdf" excl::*autoload-package-name-alist*
                :test 'equalp :key 'car))
  #+ecl (require :cmp)
  #+gcl
  (eval-when (:compile-toplevel :load-toplevel)
    (defpackage :asdf-utilities (:use :cl))
    (defpackage :asdf (:use :cl :asdf-utilities))))
66

67
;;;; Create packages in a way that is compatible with hot-upgrade.
68
69
70
;;;; See https://bugs.launchpad.net/asdf/+bug/485687
;;;; See more at the end of the file.

71
(eval-when (:load-toplevel :compile-toplevel :execute)
72
  (let* ((asdf-version ;; the 1+ helps the version bumping script discriminate
73
          (subseq "VERSION:2.107" (1+ (length "VERSION"))))
74
         (existing-asdf (find-package :asdf))
75
76
77
78
         (vername '#:*asdf-version*)
         (versym (and existing-asdf
                      (find-symbol (string vername) existing-asdf)))
         (existing-version (and versym (boundp versym) (symbol-value versym)))
79
80
         (already-there (equal asdf-version existing-version)))
    (unless (and existing-asdf already-there)
81
      #-gcl
82
      (when existing-asdf
83
        (format *trace-output*
84
85
                "~&Upgrading ASDF package ~@[from version ~A ~]to version ~A~%"
                existing-version asdf-version))
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
      (labels
          ((rename-away (package)
             (loop :with name = (package-name package)
               :for i :from 1 :for new = (format nil "~A.~D" name i)
               :unless (find-package new) :do
               (rename-package-name package name new)))
           (rename-package-name (package old new)
             (let* ((old-names (cons (package-name package)
                                     (package-nicknames package)))
                    (new-names (subst new old old-names :test 'equal))
                    (new-name (car new-names))
                    (new-nicknames (cdr new-names)))
               (rename-package package new-name new-nicknames)))
           (ensure-exists (name nicknames use)
             (let* ((previous
                     (remove-duplicates
                      (remove-if
                       #'null
                       (mapcar #'find-package (cons name nicknames)))
                      :from-end t)))
               (cond
                 (previous
                  ;; do away with packages with conflicting (nick)names
                  (map () #'rename-away (cdr previous))
                  ;; reuse previous package with same name
                  (let ((p (car previous)))
                    (rename-package p name nicknames)
                    (ensure-use p use)
                    p))
                 (t
                  (make-package name :nicknames nicknames :use use)))))
           (find-sym (symbol package)
             (find-symbol (string symbol) package))
           (intern* (symbol package)
             (intern (string symbol) package))
           (remove-symbol (symbol package)
             (let ((sym (find-sym symbol package)))
               (when sym
                 (unexport sym package)
                 (unintern sym package))))
           (ensure-unintern (package symbols)
             (dolist (sym symbols) (remove-symbol sym package)))
           (ensure-shadow (package symbols)
             (shadow symbols package))
           (ensure-use (package use)
             (dolist (used (reverse use))
               (do-external-symbols (sym used)
                 (unless (eq sym (find-sym sym package))
                   (remove-symbol sym package)))
               (use-package used package)))
           (ensure-fmakunbound (package symbols)
             (loop :for name :in symbols
               :for sym = (find-sym name package)
               :when sym :do (fmakunbound sym)))
           (ensure-export (package export)
             (let ((syms (loop :for x :in export :collect
                           (intern* x package))))
               (do-external-symbols (sym package)
                 (unless (member sym syms)
                   (remove-symbol sym package)))
               (dolist (sym syms)
                 (export sym package))))
           (ensure-package (name &key nicknames use unintern fmakunbound shadow export)
             (let ((p (ensure-exists name nicknames use)))
               (ensure-unintern p unintern)
               (ensure-shadow p shadow)
               (ensure-export p export)
               (ensure-fmakunbound p fmakunbound)
               p)))
        (macrolet
            ((pkgdcl (name &key nicknames use export
                           redefined-functions unintern fmakunbound shadow)
158
159
160
161
162
                 `(ensure-package
                   ',name :nicknames ',nicknames :use ',use :export ',export
                   :shadow ',shadow
                   :unintern ',(append #-(or gcl ecl) redefined-functions unintern)
                   :fmakunbound ',(append fmakunbound))))
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
          (pkgdcl
           :asdf-utilities
           :nicknames (#:asdf-extensions)
           :use (#:common-lisp)
           :unintern (#:split #:make-collector)
           :export
           (#:absolute-pathname-p
            #:aif
            #:appendf
            #:asdf-message
            #:coerce-name
            #:directory-pathname-p
            #:ends-with
            #:ensure-directory-pathname
            #:getenv
            #:get-uid
            #:length=n-p
            #:merge-pathnames*
            #:pathname-directory-pathname
            #:read-file-forms
            #:remove-keys
            #:remove-keyword
            #:resolve-symlinks
            #:split-string
            #:component-name-to-pathname-components
            #:split-name-type
            #:system-registered-p
            #:truenamize
            #:while-collecting))
          (pkgdcl
           :asdf
           :use (:common-lisp :asdf-utilities)
           :redefined-functions
           (#:perform #:explain #:output-files #:operation-done-p
            #:perform-with-restarts #:component-relative-pathname
            #:system-source-file #:operate #:find-component)
           :unintern
           (#:*asdf-revision* #:around #:asdf-method-combination
            #:split #:make-collector)
           :fmakunbound
           (#:system-source-file
            #:component-relative-pathname #:system-relative-pathname
            #:process-source-registry
            #:inherit-source-registry #:process-source-registry-directive)
           :export
           (#:defsystem #:oos #:operate #:find-system #:run-shell-command
            #:system-definition-pathname #:find-component ; miscellaneous
            #:compile-system #:load-system #:test-system
            #:compile-op #:load-op #:load-source-op
            #:test-op
            #:operation               ; operations
            #:feature                 ; sort-of operation
            #:version                 ; metaphorically sort-of an operation
            #:version-satisfies

            #:input-files #:output-files #:perform ; operation methods
            #:operation-done-p #:explain

            #:component #:source-file
            #:c-source-file #:cl-source-file #:java-source-file
            #:static-file
            #:doc-file
            #:html-file
            #:text-file
            #:source-file-type
            #:module                     ; components
            #:system
            #:unix-dso

            #:module-components          ; component accessors
            #:module-components-by-name  ; component accessors
            #:component-pathname
            #:component-relative-pathname
            #:component-name
            #:component-version
            #:component-parent
            #:component-property
            #:component-system

            #:component-depends-on

            #:system-description
            #:system-long-description
            #:system-author
            #:system-maintainer
            #:system-license
            #:system-licence
            #:system-source-file
            #:system-source-directory
            #:system-relative-pathname
            #:map-systems

            #:operation-on-warnings
            #:operation-on-failure
            ;;#:*component-parent-pathname*
            #:*system-definition-search-functions*
            #:*central-registry*         ; variables
            #:*compile-file-warnings-behaviour*
            #:*compile-file-failure-behaviour*
            #:*resolve-symlinks*
            #:*asdf-verbose*

            #:asdf-version

            #:operation-error #:compile-failed #:compile-warned #:compile-error
            #:error-name
            #:error-pathname
            #:load-system-definition-error
            #:error-component #:error-operation
            #:system-definition-error
            #:missing-component
            #:missing-component-of-version
            #:missing-dependency
            #:missing-dependency-of-version
            #:circular-dependency        ; errors
            #:duplicate-names

            #:try-recompiling
            #:retry
            #:accept                     ; restarts
            #:coerce-entry-to-directory
            #:remove-entry-from-registry

            #:initialize-output-translations
            #:disable-output-translations
            #:clear-output-translations
            #:ensure-output-translations
            #:apply-output-translations
291
            #:compile-file*
292
293
294
295
296
297
298
299
300
301
            #:compile-file-pathname*
            #:enable-asdf-binary-locations-compatibility

            #:*default-source-registries*
            #:initialize-source-registry
            #:compute-source-registry
            #:clear-source-registry
            #:ensure-source-registry
            #:process-source-registry)))
        (let* ((version (intern* vername :asdf))
302
303
304
305
306
307
               (upvar (intern* '#:*upgraded-p* :asdf))
               (upval0 (and (boundp upvar) (symbol-value upvar)))
               (upval1 (if existing-version (cons existing-version upval0) upval0)))
          (eval `(progn
                   (defparameter ,version ,asdf-version)
                   (defparameter ,upvar ',upval1))))))))
308

309
(in-package :asdf)
Daniel Barlow's avatar
Daniel Barlow committed
310

311
;; More cleanups in case of hot-upgrade. See https://bugs.launchpad.net/asdf/+bug/485687
312
313
314
315
#+gcl
(eval-when (:compile-toplevel :load-toplevel)
  (defvar *asdf-version* nil)
  (defvar *upgraded-p* nil))
316
317
(when *upgraded-p*
   #+ecl
318
319
320
321
322
323
324
325
326
327
328
   (when (find-class 'compile-op nil)
     (defmethod update-instance-for-redefined-class :after
         ((c compile-op) added deleted plist &key)
       (declare (ignore added deleted))
       (let ((system-p (getf plist 'system-p)))
         (when system-p (setf (getf (slot-value c 'flags) :system-p) system-p)))))
   (when (find-class 'module nil)
     (eval
      '(defmethod update-instance-for-redefined-class :after
           ((m module) added deleted plist &key)
         (declare (ignorable deleted plist))
329
         (format *trace-output* "Updating ~A~%" m)
330
331
         (when (member 'components-by-name added)
           (compute-module-components-by-name m))))))
332

333
334
335
;;;; -------------------------------------------------------------------------
;;;; User-visible parameters
;;;;
336
(defun asdf-version ()
337
  "Exported interface to the version of ASDF currently installed. A string.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
338
You can compare this string with e.g.:
339
(ASDF:VERSION-SATISFIES (ASDF:ASDF-VERSION) \"2.000\")."
340
  *asdf-version*)
341

342
343
344
345
346
(defvar *resolve-symlinks* t
  "Determine whether or not ASDF resolves symlinks when defining systems.

Defaults to `t`.")

347
348
349
(defvar *compile-file-warnings-behaviour* :warn
  "How should ASDF react if it encounters a warning when compiling a
file?  Valid values are :error, :warn, and :ignore.")
350

351
352
353
354
355
(defvar *compile-file-failure-behaviour* #+sbcl :error #-sbcl :warn
        "How should ASDF react if it encounters a failure \(per the
ANSI spec of COMPILE-FILE\) when compiling a file?  Valid values are
:error, :warn, and :ignore.  Note that ASDF ALWAYS raises an error
if it fails to create an output file when compiling.")
Daniel Barlow's avatar
   
Daniel Barlow committed
356

357
(defvar *verbose-out* nil)
358

359
360
(defvar *asdf-verbose* t)

361
(defparameter +asdf-methods+
362
  '(perform-with-restarts perform explain output-files operation-done-p))
363

364
#+allegro
365
(eval-when (:compile-toplevel :execute)
366
367
368
369
370
371
  (defparameter *acl-warn-save*
                (when (boundp 'excl:*warn-on-nested-reader-conditionals*)
                  excl:*warn-on-nested-reader-conditionals*))
  (when (boundp 'excl:*warn-on-nested-reader-conditionals*)
    (setf excl:*warn-on-nested-reader-conditionals* nil)))

372
373
;;;; -------------------------------------------------------------------------
;;;; ASDF Interface, in terms of generic functions.
374
375
376
377
378
379
380
381
382
383
384
(defmacro defgeneric* (name formals &rest options)
  `(progn
     #+(or gcl ecl) (fmakunbound ',name)
     (defgeneric ,name ,formals ,@options)))

(defgeneric* perform-with-restarts (operation component))
(defgeneric* perform (operation component))
(defgeneric* operation-done-p (operation component))
(defgeneric* explain (operation component))
(defgeneric* output-files (operation component))
(defgeneric* input-files (operation component))
385
(defgeneric component-operation-time (operation component))
386

387
(defgeneric* system-source-file (system)
388
389
390
391
392
393
394
395
396
  (:documentation "Return the source file in which system is defined."))

(defgeneric component-system (component)
  (:documentation "Find the top-level system containing COMPONENT"))

(defgeneric component-pathname (component)
  (:documentation "Extracts the pathname applicable for a particular component."))

(defgeneric component-relative-pathname (component)
397
398
399
400
401
  (:documentation "Returns a pathname for the component argument intended to be
interpreted relative to the pathname of that component's parent.
Despite the function's name, the return value may be an absolute
pathname, because an absolute pathname may be interpreted relative to
another pathname in a degenerate way."))
402
403
404
405
406
407
408

(defgeneric component-property (component property))

(defgeneric (setf component-property) (new-value component property))

(defgeneric version-satisfies (component version))

409
(defgeneric* find-component (base path)
410
411
  (:documentation "Finds the component with PATH starting from BASE module;
if BASE is nil, then the component is assumed to be a system."))
412
413
414
415
416
417
418
419

(defgeneric source-file-type (component system))

(defgeneric operation-ancestor (operation)
  (:documentation
   "Recursively chase the operation's parent pointer until we get to
the head of the tree"))

420
421
422
423
424
425
(defgeneric component-visited-p (operation component)
  (:documentation "Returns the value stored by a call to
VISIT-COMPONENT, if that has been called, otherwise NIL.
This value stored will be a cons cell, the first element
of which is a computed key, so not interesting.  The
CDR wil be the DATA value stored by VISIT-COMPONENT; recover
426
it as (cdr (component-visited-p op c)).
427
428
429
430
431
  In the current form of ASDF, the DATA value retrieved is
effectively a boolean, indicating whether some operations are
to be performed in order to do OPERATION X COMPONENT.  If the
data value is NIL, the combination had been explored, but no
operations needed to be performed."))
432
433
434
435
436
437
438
439
440
441

(defgeneric visit-component (operation component data)
  (:documentation "Record DATA as being associated with OPERATION
and COMPONENT.  This is a side-effecting function:  the association
will be recorded on the ROOT OPERATION \(OPERATION-ANCESTOR of the
OPERATION\).
  No evidence that DATA is ever interesting, beyond just being
non-NIL.  Using the data field is probably very risky; if there is
already a record for OPERATION X COMPONENT, DATA will be quietly
discarded instead of recorded."))
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465

(defgeneric (setf visiting-component) (new-value operation component))

(defgeneric component-visiting-p (operation component))

(defgeneric component-depends-on (operation component)
  (:documentation
   "Returns a list of dependencies needed by the component to perform
    the operation.  A dependency has one of the following forms:

      (<operation> <component>*), where <operation> is a class
        designator and each <component> is a component
        designator, which means that the component depends on
        <operation> having been performed on each <component>; or

      (FEATURE <feature>), which means that the component depends
        on <feature>'s presence in *FEATURES*.

    Methods specialized on subclasses of existing component types
    should usually append the results of CALL-NEXT-METHOD to the
    list."))

(defgeneric component-self-dependencies (operation component))

Gary King's avatar
Gary King committed
466
(defgeneric traverse (operation component)
467
  (:documentation
468
"Generate and return a plan for performing OPERATION on COMPONENT.
Gary King's avatar
Gary King committed
469

470
471
472
The plan returned is a list of dotted-pairs. Each pair is the CONS
of ASDF operation object and a COMPONENT object. The pairs will be
processed in order by OPERATE."))
473
474


475
476
;;;; -------------------------------------------------------------------------
;;;; General Purpose Utilities
477

478
(defmacro while-collecting ((&rest collectors) &body body)
479
480
481
482
483
484
485
486
487
488
  "COLLECTORS should be a list of names for collections.  A collector
defines a function that, when applied to an argument inside BODY, will
add its argument to the corresponding collection.  Returns multiple values,
a list for each collection, in order.
   E.g.,
\(while-collecting \(foo bar\)
           \(dolist \(x '\(\(a 1\) \(b 2\) \(c 3\)\)\)
             \(foo \(first x\)\)
             \(bar \(second x\)\)\)\)
Returns two values: \(A B C\) and \(1 2 3\)."
489
490
491
  (let ((vars (mapcar #'(lambda (x) (gensym (symbol-name x))) collectors))
        (initial-values (mapcar (constantly nil) collectors)))
    `(let ,(mapcar #'list vars initial-values)
492
       (flet ,(mapcar #'(lambda (c v) `(,c (x) (push x ,v) (values))) collectors vars)
493
         ,@body
494
         (values ,@(mapcar #'(lambda (v) `(reverse ,v)) vars))))))
495

496
497
498
(defmacro aif (test then &optional else)
  `(let ((it ,test)) (if it ,then ,else)))

499
500
501
(defun pathname-directory-pathname (pathname)
  "Returns a new pathname with same HOST, DEVICE, DIRECTORY as PATHNAME,
and NIL NAME, TYPE and VERSION components"
502
503
  (when pathname
    (make-pathname :name nil :type nil :version nil :defaults pathname)))
504

505
506
(defun merge-pathnames* (specified &optional (defaults *default-pathname-defaults*))
  "MERGE-PATHNAMES* is like MERGE-PATHNAMES except that if the SPECIFIED pathname
507
508
509
510
does not have an absolute directory, then the HOST and DEVICE come from the DEFAULTS.
Also, if either argument is NIL, then the other argument is returned unmodified."
  (when (null specified) (return-from merge-pathnames* defaults))
  (when (null defaults) (return-from merge-pathnames* specified))
511
512
513
  (let* ((specified (pathname specified))
         (defaults (pathname defaults))
         (directory (pathname-directory specified))
514
         #-sbcl (directory (if (stringp directory) `(:absolute ,directory) directory))
515
516
517
         (name (or (pathname-name specified) (pathname-name defaults)))
         (type (or (pathname-type specified) (pathname-type defaults)))
         (version (or (pathname-version specified) (pathname-version defaults))))
518
519
520
521
522
    (labels ((ununspecific (x)
               (if (eq x :unspecific) nil x))
             (unspecific-handler (p)
               (if (typep p 'logical-pathname) #'ununspecific #'identity)))
      (multiple-value-bind (host device directory unspecific-handler)
523
          (#-gcl ecase #+gcl case (first directory)
524
525
526
527
528
529
530
531
532
533
534
535
536
            ((nil)
             (values (pathname-host defaults)
                     (pathname-device defaults)
                     (pathname-directory defaults)
                     (unspecific-handler defaults)))
            ((:absolute)
             (values (pathname-host specified)
                     (pathname-device specified)
                     directory
                     (unspecific-handler specified)))
            ((:relative)
             (values (pathname-host defaults)
                     (pathname-device defaults)
537
538
539
                     (if (pathname-directory defaults)
                         (append (pathname-directory defaults) (cdr directory))
                         directory)
540
541
542
543
544
545
546
                     (unspecific-handler defaults)))
            #+gcl
            (t
             (assert (stringp (first directory)))
             (values (pathname-host defaults)
                     (pathname-device defaults)
                     (append (pathname-directory defaults) directory)
547
548
549
550
551
                     (unspecific-handler defaults))))
        (make-pathname :host host :device device :directory directory
                       :name (funcall unspecific-handler name)
                       :type (funcall unspecific-handler type)
                       :version (funcall unspecific-handler version))))))
552

553
(define-modify-macro appendf (&rest args)
554
555
556
557
  append "Append onto list") ;; only to be used on short lists.

(define-modify-macro orf (&rest args)
  or "or a flag")
Daniel Barlow's avatar
   
Daniel Barlow committed
558

559
560
561
562
563
564
(defun first-char (s)
  (and (stringp s) (plusp (length s)) (char s 0)))

(defun last-char (s)
  (and (stringp s) (plusp (length s)) (char s (1- (length s)))))

565
566
567
568
(defun asdf-message (format-string &rest format-args)
  (declare (dynamic-extent format-args))
  (apply #'format *verbose-out* format-string format-args))

569
(defun split-string (string &key max (separator '(#\Space #\Tab)))
570
571
  "Split STRING into a list of components separated by
any of the characters in the sequence SEPARATOR.
572
573
574
If MAX is specified, then no more than max(1,MAX) components will be returned,
starting the separation from the end, e.g. when called with arguments
 \"a.b.c.d.e\" :max 3 :separator \".\" it will return (\"a.b.c\" \"d\" \"e\")."
575
576
577
578
579
580
581
582
583
584
585
586
587
  (block nil
    (let ((list nil) (words 0) (end (length string)))
      (flet ((separatorp (char) (find char separator))
             (done () (return (cons (subseq string 0 end) list))))
        (loop
          :for start = (if (and max (>= words (1- max)))
                           (done)
                           (position-if #'separatorp string :end end :from-end t)) :do
          (when (null start)
            (done))
          (push (subseq string (1+ start) end) list)
          (incf words)
          (setf end start))))))
588
589

(defun split-name-type (filename)
590
591
592
593
  (let ((unspecific
         ;; Giving :unspecific as argument to make-pathname is not portable.
         ;; See CLHS make-pathname and 19.2.2.2.3.
         ;; We only use it on implementations that support it.
594
         (or #+(or ccl ecl gcl lispworks sbcl) :unspecific)))
595
596
597
598
599
    (destructuring-bind (name &optional (type unspecific))
        (split-string filename :max 2 :separator ".")
      (if (equal name "")
          (values filename unspecific)
          (values name type)))))
600

601
(defun component-name-to-pathname-components (s &optional force-directory)
602
603
604
605
606
607
608
609
610
611
  "Splits the path string S, returning three values:
A flag that is either :absolute or :relative, indicating
   how the rest of the values are to be interpreted.
A directory path --- a list of strings, suitable for
   use with MAKE-PATHNAME when prepended with the flag
   value.
A filename with type extension, possibly NIL in the
   case of a directory pathname.
FORCE-DIRECTORY forces S to be interpreted as a directory
pathname \(third return value will be NIL, final component
612
613
614
615
616
of S will be treated as part of the directory path.

The intention of this function is to support structured component names,
e.g., \(:file \"foo/bar\"\), which will be unpacked to relative
pathnames."
617
  (check-type s string)
618
  (let* ((components (split-string s :separator "/"))
619
620
621
         (last-comp (car (last components))))
    (multiple-value-bind (relative components)
        (if (equal (first components) "")
622
            (if (equal (first-char s) #\/)
623
624
                (values :absolute (cdr components))
                (values :relative nil))
625
          (values :relative components))
626
      (setf components (remove "" components :test #'equal))
627
628
      (cond
        ((equal last-comp "")
629
         (values relative components nil)) ; "" already removed
630
631
632
633
        (force-directory
         (values relative components nil))
        (t
         (values relative (butlast components) last-comp))))))
634

635
(defun remove-keys (key-names args)
636
637
638
639
640
641
642
643
644
  (loop :for (name val) :on args :by #'cddr
    :unless (member (symbol-name name) key-names
                    :key #'symbol-name :test 'equal)
    :append (list name val)))

(defun remove-keyword (key args)
  (loop :for (k v) :on args :by #'cddr
    :unless (eq k key)
    :append (list k v)))
645

646
(defun getenv (x)
Francois-Rene Rideau's avatar
1.642:    
Francois-Rene Rideau committed
647
648
  #+abcl
  (ext:getenv x)
649
650
651
  #+sbcl
  (sb-ext:posix-getenv x)
  #+clozure
652
  (ccl:getenv x)
653
654
655
656
657
  #+clisp
  (ext:getenv x)
  #+cmu
  (cdr (assoc (intern x :keyword) ext:*environment-list*))
  #+lispworks
658
  (lispworks:environment-variable x)
659
660
661
662
663
664
665
  #+allegro
  (sys:getenv x)
  #+gcl
  (system:getenv x)
  #+ecl
  (si:getenv x))

666
(defun directory-pathname-p (pathname)
667
  "Does PATHNAME represent a directory?
668
669

A directory-pathname is a pathname _without_ a filename. The three
670
671
ways that the filename components can be missing are for it to be NIL,
:UNSPECIFIC or the empty string.
672

673
Note that this does _not_ check to see that PATHNAME points to an
674
675
actually-existing directory."
  (flet ((check-one (x)
676
           (member x '(nil :unspecific "") :test 'equal)))
677
    (and (check-one (pathname-name pathname))
678
679
         (check-one (pathname-type pathname))
         t)))
680

681
682
(defun ensure-directory-pathname (pathspec)
  "Converts the non-wild pathname designator PATHSPEC to directory form."
683
684
  (cond
   ((stringp pathspec)
685
    (ensure-directory-pathname (pathname pathspec)))
686
687
688
689
690
691
692
693
694
695
696
697
   ((not (pathnamep pathspec))
    (error "Invalid pathname designator ~S" pathspec))
   ((wild-pathname-p pathspec)
    (error "Can't reliably convert wild pathnames."))
   ((directory-pathname-p pathspec)
    pathspec)
   (t
    (make-pathname :directory (append (or (pathname-directory pathspec)
                                          (list :relative))
                                      (list (file-namestring pathspec)))
                   :name nil :type nil :version nil
                   :defaults pathspec))))
698

699
700
701
(defun absolute-pathname-p (pathspec)
  (eq :absolute (car (pathname-directory (pathname pathspec)))))

702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
(defun length=n-p (x n) ;is it that (= (length x) n) ?
  (check-type n (integer 0 *))
  (loop
    :for l = x :then (cdr l)
    :for i :downfrom n :do
    (cond
      ((zerop i) (return (null l)))
      ((not (consp l)) (return nil)))))

(defun ends-with (s suffix)
  (check-type s string)
  (check-type suffix string)
  (let ((start (- (length s) (length suffix))))
    (and (<= 0 start)
         (string-equal s suffix :start1 start))))
717

718
719
720
721
722
723
724
(defun read-file-forms (file)
  (with-open-file (in file)
    (loop :with eof = (list nil)
     :for form = (read in nil eof)
     :until (eq form eof)
     :collect form)))

725
#-(and (or win32 windows mswindows mingw32) (not cygwin))
726
(progn
727
#+clisp (defun get-uid () (posix:uid))
728
729
#+sbcl (defun get-uid () (sb-unix:unix-getuid))
#+cmu (defun get-uid () (unix:unix-getuid))
730
#+ecl (ffi:clines "#include <sys/types.h>" "#include <unistd.h>")
731
732
733
734
735
#+ecl (defun get-uid () (ffi:c-inline () () :int "getuid()" :one-liner t))
#+allegro (defun get-uid () (excl.osi:getuid))
#-(or cmu sbcl clisp allegro ecl)
(defun get-uid ()
  (let ((uid-string
736
         (with-output-to-string (*verbose-out*)
737
           (run-shell-command "id -ur"))))
738
739
740
741
742
    (with-input-from-string (stream uid-string)
      (read-line stream)
      (handler-case (parse-integer (read-line stream))
        (error () (error "Unable to find out user ID")))))))

743
744
745
746
747
748
(defun pathname-root (pathname)
  (make-pathname :host (pathname-host pathname)
                 :device (pathname-device pathname)
                 :directory '(:absolute)
                 :name nil :type nil :version nil))

749
750
(defun truenamize (p)
  "Resolve as much of a pathname as possible"
751
752
  (block nil
    (when (typep p 'logical-pathname) (return p))
753
    (let* ((p (merge-pathnames* p))
754
755
756
           (directory (pathname-directory p)))
      (when (typep p 'logical-pathname) (return p))
      (ignore-errors (return (truename p)))
757
758
      #-sbcl (when (stringp directory) (return p))
      (when (not (eq :absolute (car directory))) (return p))
759
      (let ((sofar (ignore-errors (truename (pathname-root p)))))
760
        (unless sofar (return p))
761
        (flet ((solution (directories)
762
763
                 (merge-pathnames*
                  (make-pathname :host nil :device nil
764
                                 :directory `(:relative ,@directories)
765
766
                                 :name (pathname-name p)
                                 :type (pathname-type p)
767
                                 :version (pathname-version p))
768
769
770
771
772
773
774
775
776
777
                  sofar)))
          (loop :for component :in (cdr directory)
            :for rest :on (cdr directory)
            :for more = (ignore-errors
                          (truename
                           (merge-pathnames*
                            (make-pathname :directory `(:relative ,component))
                            sofar))) :do
            (if more
                (setf sofar more)
778
                (return (solution rest)))
779
780
            :finally
            (return (solution nil))))))))
781

782
783
784
785
786
787
788
(defun resolve-symlinks (path)
  #-allegro (truenamize path)
  #+allegro (excl:pathname-resolve-symbolic-links path))

(defun default-directory ()
  (truenamize (pathname-directory-pathname *default-pathname-defaults*)))

789
790
791
(defun lispize-pathname (input-file)
  (make-pathname :type "lisp" :defaults input-file))

792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
(defparameter *wild-path*
  (make-pathname :directory '(:relative :wild-inferiors)
                 :name :wild :type :wild :version :wild))

(defun wilden (path)
  (merge-pathnames* *wild-path* path))

(defun directorize-pathname-host-device (pathname)
  (let* ((root (pathname-root pathname))
         (wild-root (wilden root))
         (absolute-pathname (merge-pathnames* pathname root))
         (foo (make-pathname :directory '(:absolute "FOO") :defaults root))
         (separator (last-char (namestring foo)))
         (root-namestring (namestring root))
         (root-string
          (substitute-if #\/
                         (lambda (x) (or (eql x #\:)
                                         (eql x separator)))
                         root-namestring)))
    (multiple-value-bind (relative path filename)
        (component-name-to-pathname-components root-string t)
      (declare (ignore relative filename))
      (let ((new-base
             (make-pathname :defaults root
                            :directory `(:absolute ,@path))))
        (translate-pathname absolute-pathname wild-root (wilden new-base))))))

819
820
;;;; -------------------------------------------------------------------------
;;;; Classes, Conditions
Daniel Barlow's avatar
Daniel Barlow committed
821

822
823
824
825
826
827
828
829
830
(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))

831
832
833
834
835
836
837
838
839
(declaim (ftype (function (t) t)
                format-arguments format-control
                error-name error-pathname error-condition
                duplicate-names-name
                error-component error-operation
                module-components module-components-by-name)
         (ftype (function (t t) t) (setf module-components-by-name)))


Daniel Barlow's avatar
Daniel Barlow committed
840
(define-condition formatted-system-definition-error (system-definition-error)
841
842
843
  ((format-control :initarg :format-control :reader format-control)
   (format-arguments :initarg :format-arguments :reader format-arguments))
  (:report (lambda (c s)
844
             (apply #'format s (format-control c) (format-arguments c)))))
845

846
(define-condition load-system-definition-error (system-definition-error)
847
  ((name :initarg :name :reader error-name)
848
849
   (pathname :initarg :pathname :reader error-pathname)
   (condition :initarg :condition :reader error-condition))
850
  (:report (lambda (c s)
851
852
             (format s "~@<Error while trying to load definition for system ~A from pathname ~A: ~A~@:>"
                     (error-name c) (error-pathname c) (error-condition c)))))
853

Daniel Barlow's avatar
Daniel Barlow committed
854
(define-condition circular-dependency (system-definition-error)
855
  ((components :initarg :components :reader circular-dependency-components)))
856

857
(define-condition duplicate-names (system-definition-error)
858
859
860
861
  ((name :initarg :name :reader duplicate-names-name))
  (:report (lambda (c s)
             (format s "~@<Error while defining system: multiple components are given same name ~A~@:>"
                     (duplicate-names-name c)))))
862

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

867
868
869
(define-condition missing-component-of-version (missing-component)
  ((version :initform nil :reader missing-version :initarg :version)))

870
871
872
(define-condition missing-dependency (missing-component)
  ((required-by :initarg :required-by :reader missing-required-by)))

873
(define-condition missing-dependency-of-version (missing-dependency
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
874
                                                 missing-component-of-version)
875
876
  ())

Daniel Barlow's avatar
Daniel Barlow committed
877
878
879
880
(define-condition operation-error (error)
  ((component :reader error-component :initarg :component)
   (operation :reader error-operation :initarg :operation))
  (:report (lambda (c s)
881
882
             (format s "~@<erred while invoking ~A on ~A~@:>"
                     (error-operation c) (error-component c)))))
883
884
885
(define-condition compile-error (operation-error) ())
(define-condition compile-failed (compile-error) ())
(define-condition compile-warned (compile-error) ())
Daniel Barlow's avatar
Daniel Barlow committed
886
887

(defclass component ()
888
  ((name :accessor component-name :initarg :name :documentation
889
         "Component name: designator for a string composed of portable pathname characters")
Daniel Barlow's avatar
Daniel Barlow committed
890
   (version :accessor component-version :initarg :version)
891
892
   (in-order-to :initform nil :initarg :in-order-to
                :accessor component-in-order-to)
893
894
   ;; This one is used by POIU. Maybe in the future by ASDF instead of in-order-to?
   (load-dependencies :accessor component-load-dependencies :initform nil)
895
   ;; XXX crap name, but it's an official API name!
896
897
   (do-first :initform nil :initarg :do-first
             :accessor component-do-first)
898
899
900
901
   ;; methods defined using the "inline" style inside a defsystem form:
   ;; need to store them somewhere so we can delete them when the system
   ;; is re-evaluated
   (inline-methods :accessor component-inline-methods :initform nil)
Daniel Barlow's avatar
Daniel Barlow committed
902
   (parent :initarg :parent :initform nil :reader component-parent)
Daniel Barlow's avatar
Daniel Barlow committed
903
904
   ;; no direct accessor for pathname, we do this as a method to allow
   ;; it to default in funky ways if not supplied
Daniel Barlow's avatar
   
Daniel Barlow committed
905
   (relative-pathname :initarg :pathname)
906
   (absolute-pathname)
907
   (operation-times :initform (make-hash-table)
908
                    :accessor component-operation-times)
Daniel Barlow's avatar
   
Daniel Barlow committed
909
910
   ;; XXX we should provide some atomic interface for updating the
   ;; component properties
911
   (properties :accessor component-properties :initarg :properties
912
               :initform nil)))
Daniel Barlow's avatar
   
Daniel Barlow committed
913

914
915
916
917
918
919
920
921
922
923
(defun component-find-path (component)
  (reverse
   (loop :for c = component :then (component-parent c)
     :while c :collect (component-name c))))

(defmethod print-object ((c component) stream)
  (print-unreadable-object (c stream :type t :identity nil)
    (format stream "~@<~{~S~^ ~}~@:>" (component-find-path c))))


Daniel Barlow's avatar
   
Daniel Barlow committed
924
925
926
;;;; methods: conditions

(defmethod print-object ((c missing-dependency) s)
927
  (format s "~@<~A, required by ~A~@:>"
928
          (call-next-method c nil) (missing-required-by c)))
Daniel Barlow's avatar
   
Daniel Barlow committed
929
930

(defun sysdef-error (format &rest arguments)
931
  (error 'formatted-system-definition-error :format-control
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
932
         format :format-arguments arguments))
Daniel Barlow's avatar
Daniel Barlow committed
933

Daniel Barlow's avatar
   
Daniel Barlow committed
934
935
936
;;;; methods: components

(defmethod print-object ((c missing-component) s)
937
   (format s "~@<component ~S not found~
938
             ~@[ in ~A~]~@:>"
939
940
941
          (missing-requires c)
          (when (missing-parent c)
            (component-name (missing-parent c)))))
Daniel Barlow's avatar
   
Daniel Barlow committed
942

943
944
945
946
947
(defmethod print-object ((c missing-component-of-version) s)
  (format s "~@<component ~S does not match version ~A~
              ~@[ in ~A~]~@:>"
           (missing-requires c)
           (missing-version c)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
948
949
           (when (missing-parent c)
             (component-name (missing-parent c)))))
950

Daniel Barlow's avatar
Daniel Barlow committed
951
952
953
954
955
(defmethod component-system ((component component))
  (aif (component-parent component)
       (component-system it)
       component))

956
957
958
(defvar *default-component-class* 'cl-source-file)

(defun compute-module-components-by-name (module)
959
960
  (let ((hash (make-hash-table :test 'equal)))
    (setf (module-components-by-name module) hash)
961
962
963
964
965
966
967
968
969
    (loop :for c :in (module-components module)
      :for name = (component-name c)
      :for previous = (gethash name (module-components-by-name module))
      :do
      (when previous
        (error 'duplicate-names :name name))
      :do (setf (gethash name (module-components-by-name module)) c))
    hash))

Daniel Barlow's avatar
Daniel Barlow committed
970
(defclass module (component)
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
  ((components
    :initform nil
    :initarg :components
    :accessor module-components)
   (components-by-name
    :accessor module-components-by-name)
   ;; What to do if we can't satisfy a dependency of one of this module's
   ;; components.  This allows a limited form of conditional processing.
   (if-component-dep-fails
    :initform :fail
    :initarg :if-component-dep-fails
    :accessor module-if-component-dep-fails)
   (default-component-class
    :initform *default-component-class*
    :initarg :default-component-class
    :accessor module-default-component-class)))
Daniel Barlow's avatar
Daniel Barlow committed
987

Daniel Barlow's avatar
   
Daniel Barlow committed
988
(defun component-parent-pathname (component)
989
990
991
992
993
994
995
  ;; No default anymore (in particular, no *default-pathname-defaults*).
  ;; If you force component to have a NULL pathname, you better arrange
  ;; for any of its children to explicitly provide a proper absolute pathname
  ;; wherever a pathname is actually wanted.
  (let ((parent (component-parent component)))
    (when parent
      (component-pathname parent))))
Daniel Barlow's avatar
   
Daniel Barlow committed
996
997

(defmethod component-pathname ((component component))
998
999
1000
1001
1002
  (if (slot-boundp component 'absolute-pathname)
      (slot-value component 'absolute-pathname)
      (let ((pathname
             (merge-pathnames*
             (component-relative-pathname component)
1003
             (pathname-directory-pathname (component-parent-pathname component)))))
1004
1005
1006
1007
        (unless (or (null pathname) (absolute-pathname-p pathname))
          (error "Invalid relative pathname ~S for component ~S" pathname component))
        (setf (slot-value component 'absolute-pathname) pathname)
        pathname)))
Daniel Barlow's avatar
   
Daniel Barlow committed
1008

1009
(defmethod component-property ((c component) property)
Daniel Barlow's avatar
Daniel Barlow committed
1010
  (cdr (assoc property (slot-value c 'properties) :test #'equal)))
1011
1012

(defmethod (setf component-property) (new-value (c component) property)
Daniel Barlow's avatar
Daniel Barlow committed
1013
  (let ((a (assoc property (slot-value c 'properties) :test #'equal)))
1014
    (if a
1015
1016
        (setf (cdr a) new-value)
        (setf (slot-value c 'properties)
Francois-Rene Rideau's avatar
1.675.    
Francois-Rene Rideau committed
1017
1018
              (acons property new-value (slot-value c 'properties)))))
  new-value)
1019

Daniel Barlow's avatar
   
Daniel Barlow committed
1020
1021
(defclass system (module)
  ((description :accessor system-description :initarg :description)
Daniel Barlow's avatar
Daniel Barlow committed
1022
1023
   (long-description
    :accessor system-long-description :initarg :long-description)
Daniel Barlow's avatar
   
Daniel Barlow committed
1024
1025
   (author :accessor system-author :initarg :author)
   (maintainer :accessor system-maintainer :initarg :maintainer)
1026
   (licence :accessor system-licence :initarg :licence
1027
1028
            :accessor system-license :initarg :license)
   (source-file :reader system-source-file :initarg :source-file
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1029
                :writer %set-system-source-file)))
Daniel Barlow's avatar
   
Daniel Barlow committed
1030

1031
1032
;;;; -------------------------------------------------------------------------
;;;; version-satisfies
Daniel Barlow's avatar
   
Daniel Barlow committed
1033
1034
1035
1036

(defmethod version-satisfies ((c component) version)
  (unless (and version (slot-boundp c 'version))
    (return-from version-satisfies t))
1037
1038
1039
  (version-satisfies (component-version c) version))

(defmethod version-satisfies ((cver string) version)
Daniel Barlow's avatar
   
Daniel Barlow committed
1040
  (let ((x (mapcar #'parse-integer
1041
                   (split-string cver :separator ".")))
1042
        (y (mapcar #'parse-integer
1043
                   (split-string version :separator "."))))
Daniel Barlow's avatar
   
Daniel Barlow committed
1044
    (labels ((bigger (x y)
1045
1046
1047
1048
1049
               (cond ((not y) t)
                     ((not x) nil)
                     ((> (car x) (car y)) t)
                     ((= (car x) (car y))
                      (bigger (cdr x) (cdr y))))))
Daniel Barlow's avatar
   
Daniel Barlow committed
1050
      (and (= (car x) (car y))
1051
           (or (not (cdr y)) (bigger (cdr x) (cdr y)))))))
Daniel Barlow's avatar
   
Daniel Barlow committed
1052

1053
1054
;;;; -------------------------------------------------------------------------
;;;; Finding systems
Daniel Barlow's avatar
   
Daniel Barlow committed
1055

Gary King's avatar
Gary King committed
1056
1057
1058
(defun make-defined-systems-table ()
  (make-hash-table :test 'equal))

1059
1060
1061
1062
1063
1064
(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.")
Gary King's avatar
Gary King committed
1065

Daniel Barlow's avatar
   
Daniel Barlow committed
1066
(defun coerce-name (name)
1067
1068
1069
1070
1071
  (typecase name
    (component (component-name name))
    (symbol (string-downcase (symbol-name name)))
    (string name)
    (t (sysdef-error "~@<invalid component designator ~A~@:>" name))))
Daniel Barlow's avatar
   
Daniel Barlow committed
1072

1073
1074
1075
(defun system-registered-p (name)
  (gethash (coerce-name name) *defined-systems*))

Gary King's avatar
Gary King committed
1076
(defun map-systems (fn)
1077
  "Apply FN to each defined system.
Gary King's avatar
Gary King committed
1078

1079
FN should be a function of one argument. It will be
Gary King's avatar
Gary King committed
1080
1081
called with an object of type asdf:system."
  (maphash (lambda (_ datum)
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1082
1083
1084
1085
1086
             (declare (ignore _))
             (destructuring-bind (_ . def) datum
               (declare (ignore _))
               (funcall fn def)))
           *defined-systems*))
1087

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

1091
(defparameter *system-definition-search-functions*
1092
1093
  '(sysdef-central-registry-search sysdef-source-registry-search sysdef-find-asdf))

1094
(defun system-definition-pathname (system)
1095
1096
1097
  (let ((system-name (coerce-name system)))
    (or
     (some (lambda (x) (funcall x system-name))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1098
           *system-definition-search-functions*)
1099
     (let ((system-pair (system-registered-p system-name)))
1100
       (and system-pair
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1101
            (system-source-file (cdr system-pair)))))))
1102

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1103
(defvar *central-registry* nil
1104
1105
"A list of 'system directory designators' ASDF uses to find systems.

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1106
A 'system directory designator' is a pathname or an expression
1107
1108
1109
1110
1111
1112
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/\"))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1113
1114
1115

This is for backward compatibilily.
Going forward, we recommend new users should be using the source-registry.
1116
")
1117

1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
(defun probe-asd (name defaults)
  (block nil
    (when (directory-pathname-p defaults)
      (let ((file
             (make-pathname
              :defaults defaults :version :newest :case :local
              :name name
              :type "asd")))
        (when (probe-file file)
          (return file)))
      #+(and (or win32 windows mswindows mingw32) (not cygwin) (not clisp))
      (let ((shortcut
             (make-pathname
              :defaults defaults :version :newest :case :local
              :name (concatenate 'string name ".asd")
              :type "lnk")))
        (when (probe-file shortcut)
          (let ((target (parse-windows-shortcut shortcut)))
            (when target
              (return (pathname target)))))))))

1139
(defun sysdef-central-registry-search (system)
1140
  (let ((name (coerce-name system))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1141
1142
        (to-remove nil)
        (to-replace nil))
1143
    (block nil
1144
      (unwind-protect
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1145
1146
1147
1148
           (dolist (dir *central-registry*)
             (let ((defaults (eval dir)))
               (when defaults
                 (cond ((directory-pathname-p defaults)
1149
1150
1151
                        (let ((file (probe-asd name defaults)))
                          (when file
                            (return file))))
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1152
1153
1154
1155
1156
                       (t
                        (restart-case
                            (let* ((*print-circle* nil)
                                   (message
                                    (format nil
1157
1158
                                            "~@<While searching for system ~S: ~S evaluated ~
to ~S which is not a directory.~@:>"
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
                                            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 ()
                            :report (lambda (s)
                                      (format s "Coerce entry to ~a, replace ~a and continue."
                                              (ensure-directory-pathname defaults) dir))
                            (push (cons dir (ensure-directory-pathname defaults)) to-replace))))))))
        ;; 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))))))))))
1180

Christophe Rhodes's avatar
Fixes    
Christophe Rhodes committed
1181
1182
1183
(defun make-temporary-package ()
  (flet ((try (counter)
           (ignore-errors
1184
             (make-package (format nil "~A~D" :asdf counter)
1185
                           :use '(:cl :asdf)))))
Christophe Rhodes's avatar
Fixes    
Christophe Rhodes committed
1186
1187
1188
    (do* ((counter 0 (+ counter 1))
          (package (try counter) (try counter)))
         (package package))))
1189

1190
(defun safe-file-write-date (pathname)
1191
1192
1193
1194
1195
1196
1197
1198
  ;; If FILE-WRITE-DATE returns NIL, it's possible that
  ;; the user or some other agent has deleted an input file.
  ;; Also, generated files will not exist at the time planning is done
  ;; and calls operation-done-p which calls safe-file-write-date.
  ;; So it is very possible that we can't get a valid file-write-date,
  ;; and we can survive and we will continue the planning
  ;; as if the file were very old.
  ;; (or should we treat the case in a different, special way?)
1199
  (or (and pathname (probe-file pathname) (file-write-date pathname))
1200
      (progn
1201
1202
1203
        (when pathname
          (warn "Missing FILE-WRITE-DATE for ~S: treating it as zero."
                pathname))
1204
        0)))
1205

Daniel Barlow's avatar
   
Daniel Barlow committed
1206
(defun find-system (name &optional (error-p t))
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
  (catch 'find-system
    (let* ((name (coerce-name name))
           (in-memory (system-registered-p name))
           (on-disk (system-definition-pathname name)))
      (when (and on-disk
                 (or (not in-memory)
                     (< (car in-memory) (safe-file-write-date on-disk))))
        (let ((package (make-temporary-package)))
          (unwind-protect
               (handler-bind
                   ((error (lambda (condition)
                             (error 'load-system-definition-error
                                    :name name :pathname on-disk
                                    :condition condition))))
                 (let ((*package* package))
                   (asdf-message
                    "~&~@<; ~@;loading system definition from ~A into ~A~@:>~%"
                    on-disk *package*)
                   (load on-disk)))
            (delete-package package))))
      (let ((in-memory (system-registered-p name)))
        (if in-memory
            (progn (when on-disk (setf (car in-memory)
                                       (safe-file-write-date on-disk)))
                   (cdr