asdf.lisp 158 KB
Newer Older
1
;;; -*- mode: common-lisp; Base: 10 ; Syntax: ANSI-Common-Lisp -*-
2
;;; This is ASDF 2.013.6: 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
14
15
;;; bugs.  There are usually two "supported" revisions - the git master
;;; branch is the latest development version, whereas the git release
;;; branch may be slightly older but is considered `stable'
16

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
(cl:in-package #-genera :common-lisp-user #+genera :future-common-lisp-user)
51

52
53
#+gcl (defpackage :asdf (:use :cl)) ;; GCL treats defpackage magically and needs this

54
(eval-when (:compile-toplevel :load-toplevel :execute)
55
56
57
  ;;; make package if it doesn't exist yet.
  ;;; DEFPACKAGE may cause errors on discrepancies, so we avoid it.
  (unless (find-package :asdf)
58
    (make-package :asdf :use '(:common-lisp)))
59
  ;;; Implementation-dependent tweaks
60
  ;; (declaim (optimize (speed 2) (debug 2) (safety 3))) ; NO: rely on the implementation defaults.
61
62
63
64
  #+allegro
  (setf excl::*autoload-package-name-alist*
        (remove "asdf" excl::*autoload-package-name-alist*
                :test 'equalp :key 'car))
65
  #+(and ecl (not ecl-bytecmp)) (require :cmp)
66
67
  #+(and (or win32 windows mswindows mingw32) (not cygwin)) (pushnew :asdf-windows *features*)
  #+(or unix cygwin) (pushnew :asdf-unix *features*))
68
69

(in-package :asdf)
70

71
;;;; Create packages in a way that is compatible with hot-upgrade.
72
;;;; See https://bugs.launchpad.net/asdf/+bug/485687
73
;;;; See more near the end of the file.
74

75
(eval-when (:load-toplevel :compile-toplevel :execute)
76
77
  (defvar *asdf-version* nil)
  (defvar *upgraded-p* nil)
78
  (let* (;; For bug reporting sanity, please always bump this version when you modify this file.
79
80
         ;; Please also modify asdf.asd to reflect this change. The script bin/bump-version
         ;; can help you do these changes in synch (look at the source for documentation).
81
         ;; Relying on its automation, the version is now redundantly present on top of this file.
82
83
         ;; "2.345" would be an official release
         ;; "2.345.6" would be a development version in the official upstream
84
85
         ;; "2.345.0.7" would be your seventh local modification of official release 2.345
         ;; "2.345.6.7" would be your seventh local modification of development version 2.345.6
86
         (asdf-version "2.013.6")
87
88
         (existing-asdf (fboundp 'find-system))
         (existing-version *asdf-version*)
89
90
         (already-there (equal asdf-version existing-version)))
    (unless (and existing-asdf already-there)
91
      (when existing-asdf
92
        (format *trace-output*
93
         "~&; Upgrading ASDF ~@[from version ~A ~]to version ~A~%"
94
         existing-version asdf-version))
95
      (labels
96
          ((present-symbol-p (symbol package)
97
             (member (nth-value 1 (find-sym symbol package)) '(:internal :external)))
98
99
100
101
102
103
104
           (present-symbols (package)
             ;; #-genera (loop :for s :being :the :present-symbols :in package :collect s) #+genera
             (let (l)
               (do-symbols (s package)
                 (when (present-symbol-p s package) (push s l)))
               (reverse l)))
           (unlink-package (package)
105
106
             (let ((u (find-package package)))
               (when u
107
                 (ensure-unintern u (present-symbols u))
108
109
110
                 (loop :for p :in (package-used-by-list u) :do
                   (unuse-package u p))
                 (delete-package u))))
111
           (ensure-exists (name nicknames use)
112
113
114
115
116
117
118
119
120
121
             (let ((previous
                    (remove-duplicates
                     (mapcar #'find-package (cons name nicknames))
                     :from-end t)))
               ;; do away with packages with conflicting (nick)names
               (map () #'unlink-package (cdr previous))
               ;; reuse previous package with same name
               (let ((p (car previous)))
                 (cond
                   (p
122
123
                    (rename-package p name nicknames)
                    (ensure-use p use)
124
125
126
                    p)
                   (t
                    (make-package name :nicknames nicknames :use use))))))
127
128
129
130
131
132
133
134
           (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)
135
136
                 (unintern sym package)
                 sym)))
137
           (ensure-unintern (package symbols)
138
139
140
141
142
143
144
             (loop :with packages = (list-all-packages)
               :for sym :in symbols
               :for removed = (remove-symbol sym package)
               :when removed :do
               (loop :for p :in packages :do
                 (when (eq removed (find-sym sym p))
                   (unintern removed p)))))
145
146
147
148
149
150
151
152
153
154
155
156
157
           (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)
158
159
160
             (let ((formerly-exported-symbols nil)
                   (bothly-exported-symbols nil)
                   (newly-exported-symbols nil))
161
               (do-external-symbols (sym package)
162
163
164
165
166
167
168
169
170
171
172
173
174
175
                 (if (member sym export :test 'string-equal)
                     (push sym bothly-exported-symbols)
                     (push sym formerly-exported-symbols)))
               (loop :for sym :in export :do
                 (unless (member sym bothly-exported-symbols :test 'string-equal)
                   (push sym newly-exported-symbols)))
               (loop :for user :in (package-used-by-list package)
                 :for shadowing = (package-shadowing-symbols user) :do
                 (loop :for new :in newly-exported-symbols
                   :for old = (find-sym new user)
                   :when (and old (not (member old shadowing)))
                   :do (unintern old user)))
               (loop :for x :in newly-exported-symbols :do
                 (export (intern* x package)))))
176
           (ensure-package (name &key nicknames use unintern fmakunbound shadow export)
177
             (let* ((p (ensure-exists name nicknames use)))
178
179
180
181
182
183
184
185
               (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)
186
187
188
189
190
                 `(ensure-package
                   ',name :nicknames ',nicknames :use ',use :export ',export
                   :shadow ',shadow
                   :unintern ',(append #-(or gcl ecl) redefined-functions unintern)
                   :fmakunbound ',(append fmakunbound))))
191
192
          (pkgdcl
           :asdf
193
           :nicknames (:asdf-utilities) ;; DEPRECATED! Do not use, for backward compatibility only.
194
           :use (:common-lisp)
195
196
197
           :redefined-functions
           (#:perform #:explain #:output-files #:operation-done-p
            #:perform-with-restarts #:component-relative-pathname
198
            #:system-source-file #:operate #:find-component #:find-system
199
200
            #:apply-output-translations #:translate-pathname* #:resolve-location
            #:compile-file*)
201
202
           :unintern
           (#:*asdf-revision* #:around #:asdf-method-combination
203
204
            #:split #:make-collector
            #:output-files-for-system-and-operation) ; obsolete ASDF-BINARY-LOCATION function
205
206
207
208
209
210
211
212
           :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
213
            #:compile-system #:load-system #:test-system #:clear-system
214
215
216
217
218
219
220
            #:compile-op #:load-op #:load-source-op
            #:test-op
            #:operation               ; operations
            #:feature                 ; sort-of operation
            #:version                 ; metaphorically sort-of an operation
            #:version-satisfies

221
            #:input-files #:output-files #:output-file #:perform ; operation methods
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
            #: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

258
            #:operation-description
259
260
            #:operation-on-warnings
            #:operation-on-failure
261
            #:component-visited-p
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
            ;;#:*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

291
            #:clear-configuration
292
            #:*output-translations-parameter*
293
294
295
296
297
            #:initialize-output-translations
            #:disable-output-translations
            #:clear-output-translations
            #:ensure-output-translations
            #:apply-output-translations
298
            #:compile-file*
299
300
301
            #:compile-file-pathname*
            #:enable-asdf-binary-locations-compatibility
            #:*default-source-registries*
302
            #:*source-registry-parameter*
303
304
305
306
            #:initialize-source-registry
            #:compute-source-registry
            #:clear-source-registry
            #:ensure-source-registry
307
            #:process-source-registry
308
309
            #:system-registered-p
            #:asdf-message
310

311
312
            ;; Utilities
            #:absolute-pathname-p
313
            ;; #:aif #:it
314
            ;; #:appendf
315
316
            #:coerce-name
            #:directory-pathname-p
317
            ;; #:ends-with
318
319
            #:ensure-directory-pathname
            #:getenv
320
321
            ;; #:get-uid
            ;; #:length=n-p
322
            ;; #:find-symbol*
323
            #:merge-pathnames*
324
            #:coerce-pathname
325
326
            #:pathname-directory-pathname
            #:read-file-forms
327
328
            ;; #:remove-keys
            ;; #:remove-keyword
329
330
331
332
            #:resolve-symlinks
            #:split-string
            #:component-name-to-pathname-components
            #:split-name-type
333
            #:subdirectories
334
335
            #:truenamize
            #:while-collecting)))
336
	#+genera (import 'scl:boolean :asdf)
337
338
339
340
        (setf *asdf-version* asdf-version
              *upgraded-p* (if existing-version
                               (cons existing-version *upgraded-p*)
                               *upgraded-p*))))))
Daniel Barlow's avatar
Daniel Barlow committed
341

342
343
344
;;;; -------------------------------------------------------------------------
;;;; User-visible parameters
;;;;
345
(defun asdf-version ()
346
  "Exported interface to the version of ASDF currently installed. A string.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
347
You can compare this string with e.g.:
348
(ASDF:VERSION-SATISFIES (ASDF:ASDF-VERSION) \"2.013\")."
349
  *asdf-version*)
350

351
352
353
(defvar *resolve-symlinks* t
  "Determine whether or not ASDF resolves symlinks when defining systems.

354
Defaults to T.")
355

356
357
358
359
(defvar *compile-file-warnings-behaviour*
  (or #+clisp :ignore :warn)
  "How should ASDF react if it encounters a warning when compiling a file?
Valid values are :error, :warn, and :ignore.")
360

361
362
363
364
365
(defvar *compile-file-failure-behaviour*
  (or #+sbcl :error #+clisp :ignore :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
366

367
(defvar *verbose-out* nil)
368

369
370
(defvar *asdf-verbose* t)

371
(defparameter +asdf-methods+
372
  '(perform-with-restarts perform explain output-files operation-done-p))
373

374
#+allegro
375
(eval-when (:compile-toplevel :execute)
376
377
378
379
380
381
  (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)))

382
;;;; -------------------------------------------------------------------------
383
384
;;;; General Purpose Utilities

385
386
387
388
389
390
391
392
393
394
(macrolet
    ((defdef (def* def)
       `(defmacro ,def* (name formals &rest rest)
          `(progn
             #+(or ecl gcl) (fmakunbound ',name)
             ,(when (and #+ecl (symbolp name))
                `(declaim (notinline ,name))) ; fails for setf functions on ecl
             (,',def ,name ,formals ,@rest)))))
  (defdef defgeneric* defgeneric)
  (defdef defun* defun))
395

396
(defmacro while-collecting ((&rest collectors) &body body)
397
398
399
400
401
402
403
404
405
406
  "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\)."
407
408
409
  (let ((vars (mapcar #'(lambda (x) (gensym (symbol-name x))) collectors))
        (initial-values (mapcar (constantly nil) collectors)))
    `(let ,(mapcar #'list vars initial-values)
410
       (flet ,(mapcar #'(lambda (c v) `(,c (x) (push x ,v) (values))) collectors vars)
411
         ,@body
412
         (values ,@(mapcar #'(lambda (v) `(reverse ,v)) vars))))))
413

414
415
416
(defmacro aif (test then &optional else)
  `(let ((it ,test)) (if it ,then ,else)))

417
(defun* pathname-directory-pathname (pathname)
418
419
  "Returns a new pathname with same HOST, DEVICE, DIRECTORY as PATHNAME,
and NIL NAME, TYPE and VERSION components"
420
421
  (when pathname
    (make-pathname :name nil :type nil :version nil :defaults pathname)))
422

423
424
(defun* normalize-pathname-directory-component (directory)
  (cond
425
    #-(or cmu sbcl scl)
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
    ((stringp directory) `(:absolute ,directory) directory)
    #+gcl
    ((and (consp directory) (stringp (first directory)))
     `(:absolute ,@directory))
    ((or (null directory)
         (and (consp directory) (member (first directory) '(:absolute :relative))))
     directory)
    (t
     (error "Unrecognized pathname directory component ~S" directory))))

(defun* merge-pathname-directory-components (specified defaults)
  (let ((directory (normalize-pathname-directory-component specified)))
    (ecase (first directory)
      ((nil) defaults)
      (:absolute specified)
      (:relative
       (let ((defdir (normalize-pathname-directory-component defaults))
             (reldir (cdr directory)))
         (cond
           ((null defdir)
            directory)
           ((not (eq :back (first reldir)))
            (append defdir reldir))
           (t
            (loop :with defabs = (first defdir)
              :with defrev = (reverse (rest defdir))
              :while (and (eq :back (car reldir))
                          (or (and (eq :absolute defabs) (null defrev))
                              (stringp (car defrev))))
              :do (pop reldir) (pop defrev)
              :finally (return (cons defabs (append (reverse defrev) reldir)))))))))))

458
(defun* merge-pathnames* (specified &optional (defaults *default-pathname-defaults*))
459
  "MERGE-PATHNAMES* is like MERGE-PATHNAMES except that if the SPECIFIED pathname
460
461
462
463
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))
464
465
466
  #+scl
  (ext:resolve-pathname specified defaults)
  #-scl
467
468
  (let* ((specified (pathname specified))
         (defaults (pathname defaults))
469
         (directory (normalize-pathname-directory-component (pathname-directory specified)))
470
471
472
         (name (or (pathname-name specified) (pathname-name defaults)))
         (type (or (pathname-type specified) (pathname-type defaults)))
         (version (or (pathname-version specified) (pathname-version defaults))))
473
474
475
476
477
    (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)
478
          (ecase (first directory)
479
480
481
482
483
            ((:absolute)
             (values (pathname-host specified)
                     (pathname-device specified)
                     directory
                     (unspecific-handler specified)))
484
            ((nil :relative)
485
486
             (values (pathname-host defaults)
                     (pathname-device defaults)
487
                     (merge-pathname-directory-components directory (pathname-directory defaults))
488
489
490
491
492
                     (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))))))
493

494
495
496
497
498
499
500
501
502
(defun* pathname-parent-directory-pathname (pathname)
  "Returns a new pathname with same HOST, DEVICE, DIRECTORY as PATHNAME,
and NIL NAME, TYPE and VERSION components"
  (when pathname
    (make-pathname :name nil :type nil :version nil
                   :directory (merge-pathname-directory-components '(:relative :back) (pathname-directory pathname))
                   :defaults pathname)))


503
(define-modify-macro appendf (&rest args)
504
505
506
507
  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
508

509
(defun* first-char (s)
510
511
  (and (stringp s) (plusp (length s)) (char s 0)))

512
(defun* last-char (s)
513
514
  (and (stringp s) (plusp (length s)) (char s (1- (length s)))))

515
516
517
518
519
520
(defun* errfmt (out format-string &rest format-args)
  (declare (dynamic-extent format-args))
  (apply #'format out
         #-genera (format nil "~~@<~A~~:>" format-string) #+genera format-string
         format-args))

521
(defun* asdf-message (format-string &rest format-args)
522
  (declare (dynamic-extent format-args))
523
  (apply #'format *verbose-out* format-string format-args))
524

525
(defun* split-string (string &key max (separator '(#\Space #\Tab)))
526
527
  "Split STRING into a list of components separated by
any of the characters in the sequence SEPARATOR.
528
529
530
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\")."
531
532
533
534
535
536
537
538
539
540
541
542
543
  (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))))))
544

545
(defun* split-name-type (filename)
546
547
548
549
  (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.
550
         (or #+(or clozure gcl lispworks sbcl) :unspecific)))
551
552
553
554
555
    (destructuring-bind (name &optional (type unspecific))
        (split-string filename :max 2 :separator ".")
      (if (equal name "")
          (values filename unspecific)
          (values name type)))))
556

557
(defun* component-name-to-pathname-components (s &key force-directory force-relative)
558
559
560
561
562
563
564
565
566
567
  "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
568
569
570
571
572
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."
573
  (check-type s string)
574
575
  (when (find #\: s)
    (error "a portable ASDF pathname designator cannot include a #\: character: ~S" s))
576
  (let* ((components (split-string s :separator "/"))
577
578
579
         (last-comp (car (last components))))
    (multiple-value-bind (relative components)
        (if (equal (first components) "")
580
            (if (equal (first-char s) #\/)
581
582
583
584
                (progn
                  (when force-relative
                    (error "absolute pathname designator not allowed: ~S" s))
                  (values :absolute (cdr components)))
585
                (values :relative nil))
586
          (values :relative components))
587
588
      (setf components (remove-if #'(lambda (x) (member x '("" ".") :test #'equal)) components))
      (setf components (substitute :back ".." components :test #'equal))
589
590
      (cond
        ((equal last-comp "")
591
         (values relative components nil)) ; "" already removed
592
593
594
595
        (force-directory
         (values relative components nil))
        (t
         (values relative (butlast components) last-comp))))))
596

597
(defun* remove-keys (key-names args)
598
599
600
601
602
  (loop :for (name val) :on args :by #'cddr
    :unless (member (symbol-name name) key-names
                    :key #'symbol-name :test 'equal)
    :append (list name val)))

603
(defun* remove-keyword (key args)
604
605
606
  (loop :for (k v) :on args :by #'cddr
    :unless (eq k key)
    :append (list k v)))
607

608
609
610
611
#+mcl
(eval-when (:compile-toplevel :load-toplevel :execute)
  (ccl:define-entry-point (_getenv "getenv") ((name :string)) :string))

612
(defun* getenv (x)
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
  (declare (ignorable x))
  #+(or abcl clisp) (ext:getenv x)
  #+allegro (sys:getenv x)
  #+clozure (ccl:getenv x)
  #+(or cmu scl) (cdr (assoc x ext:*environment-list* :test #'string=))
  #+ecl (si:getenv x)
  #+gcl (system:getenv x)
  #+genera nil
  #+lispworks (lispworks:environment-variable x)
  #+mcl (ccl:with-cstrs ((name x))
          (let ((value (_getenv name)))
            (unless (ccl:%null-ptr-p value)
              (ccl:%get-cstring value))))
  #+sbcl (sb-ext:posix-getenv x)
  #-(or abcl allegro clisp clozure cmu ecl gcl genera lispworks mcl sbcl scl)
  (error "getenv not available on your implementation"))
629

630
(defun* directory-pathname-p (pathname)
631
  "Does PATHNAME represent a directory?
632
633

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

637
Note that this does _not_ check to see that PATHNAME points to an
638
actually-existing directory."
639
640
641
642
643
644
645
646
  (when pathname
    (let ((pathname (pathname pathname)))
      (flet ((check-one (x)
               (member x '(nil :unspecific "") :test 'equal)))
        (and (not (wild-pathname-p pathname))
             (check-one (pathname-name pathname))
             (check-one (pathname-type pathname))
             t)))))
647

648
(defun* ensure-directory-pathname (pathspec)
649
  "Converts the non-wild pathname designator PATHSPEC to directory form."
650
651
  (cond
   ((stringp pathspec)
652
    (ensure-directory-pathname (pathname pathspec)))
653
654
655
   ((not (pathnamep pathspec))
    (error "Invalid pathname designator ~S" pathspec))
   ((wild-pathname-p pathspec)
656
    (error "Can't reliably convert wild pathname ~S" pathspec))
657
658
659
660
661
662
663
664
   ((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))))
665

666
667
668
669
670
#+genera
(unless (fboundp 'ensure-directories-exist)
  (defun ensure-directories-exist (path)
    (fs:create-directories-recursively (pathname path))))

671
(defun* absolute-pathname-p (pathspec)
672
673
  (and (typep pathspec '(or pathname string))
       (eq :absolute (car (pathname-directory (pathname pathspec))))))
674

675
(defun* length=n-p (x n) ;is it that (= (length x) n) ?
676
677
678
679
680
681
682
683
  (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)))))

684
(defun* ends-with (s suffix)
685
686
687
688
689
  (check-type s string)
  (check-type suffix string)
  (let ((start (- (length s) (length suffix))))
    (and (<= 0 start)
         (string-equal s suffix :start1 start))))
690

691
(defun* read-file-forms (file)
692
693
694
695
696
697
  (with-open-file (in file)
    (loop :with eof = (list nil)
     :for form = (read in nil eof)
     :until (eq form eof)
     :collect form)))

698
#+asdf-unix
699
(progn
700
701
  #+ecl #.(cl:and (cl:< ext:+ecl-version-number+ 100601)
                  '(ffi:clines "#include <sys/types.h>" "#include <unistd.h>"))
702
  (defun* get-uid ()
703
    #+allegro (excl.osi:getuid)
704
    #+clisp (loop :for s :in '("posix:uid" "LINUX:getuid")
705
                  :for f = (ignore-errors (read-from-string s))
706
                  :when f :return (funcall f))
707
708
709
710
711
712
713
714
715
716
717
718
719
    #+(or cmu scl) (unix:unix-getuid)
    #+ecl #.(cl:if (cl:< ext:+ecl-version-number+ 100601)
                   '(ffi:c-inline () () :int "getuid()" :one-liner t)
                   '(ext::getuid))
    #+sbcl (sb-unix:unix-getuid)
    #-(or allegro clisp cmu ecl sbcl scl)
    (let ((uid-string
           (with-output-to-string (*verbose-out*)
             (run-shell-command "id -ur"))))
      (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")))))))
720

721
(defun* pathname-root (pathname)
722
  (make-pathname :directory '(:absolute)
723
                 :name nil :type nil :version nil
724
725
                 :defaults pathname ;; host device, and on scl scheme scheme-specific-part port username password
                 . #.(or #+scl '(:parameters nil :query nil :fragment nil))))
726

727
728
729
(defun* find-symbol* (s p)
  (find-symbol (string s) p))

730
(defun* probe-file* (p)
731
732
  "when given a pathname P, probes the filesystem for a file or directory
with given pathname and if it exists return its truename."
733
734
735
736
737
  (etypecase p
   (null nil)
   (string (probe-file* (parse-namestring p)))
   (pathname (unless (wild-pathname-p p)
               #.(or #+(or allegro clozure cmu ecl sbcl scl) '(probe-file p)
738
739
                     #+clisp (aif (find-symbol (string '#:probe-pathname) :ext) `(ignore-errors (,it p)))
                     '(ignore-errors (truename p)))))))
740

741
(defun* truenamize (p)
742
  "Resolve as much of a pathname as possible"
743
  (block nil
744
    (when (typep p '(or null logical-pathname)) (return p))
745
    (let* ((p (merge-pathnames* p))
746
747
           (directory (pathname-directory p)))
      (when (typep p 'logical-pathname) (return p))
748
749
      (let ((found (probe-file* p)))
        (when found (return found)))
750
      #-(or cmu sbcl scl) (when (stringp directory) (return p))
751
      (when (not (eq :absolute (car directory))) (return p))
752
      (let ((sofar (probe-file* (pathname-root p))))
753
        (unless sofar (return p))
754
        (flet ((solution (directories)
755
756
                 (merge-pathnames*
                  (make-pathname :host nil :device nil
757
                                 :directory `(:relative ,@directories)
758
759
                                 :name (pathname-name p)
                                 :type (pathname-type p)
760
                                 :version (pathname-version p))
761
762
763
                  sofar)))
          (loop :for component :in (cdr directory)
            :for rest :on (cdr directory)
764
765
766
767
            :for more = (probe-file*
                         (merge-pathnames*
                          (make-pathname :directory `(:relative ,component))
                          sofar)) :do
768
769
            (if more
                (setf sofar more)
770
                (return (solution rest)))
771
772
            :finally
            (return (solution nil))))))))
773

774
(defun* resolve-symlinks (path)
775
  #-allegro (truenamize path)
776
777
778
  #+allegro (if (typep path 'logical-pathname)
                path
                (excl:pathname-resolve-symbolic-links path)))
779

780
(defun* default-directory ()
781
782
  (truenamize (pathname-directory-pathname *default-pathname-defaults*)))

783
(defun* lispize-pathname (input-file)
784
785
  (make-pathname :type "lisp" :defaults input-file))

786
787
788
789
790
791
(defparameter *wild-file*
  (make-pathname :name :wild :type :wild :version :wild :directory nil))
(defparameter *wild-directory*
  (make-pathname :directory '(:relative :wild) :name nil :type nil :version nil))
(defparameter *wild-inferiors*
  (make-pathname :directory '(:relative :wild-inferiors) :name nil :type nil :version nil))
792
(defparameter *wild-path*
793
  (merge-pathnames *wild-file* *wild-inferiors*))
794

795
(defun* wilden (path)
796
797
  (merge-pathnames* *wild-path* path))

798
#-scl
799
800
801
802
(defun directory-separator-for-host (&optional (pathname *default-pathname-defaults*))
  (let ((foo (make-pathname :directory '(:absolute "FOO") :defaults pathname)))
    (last-char (namestring foo))))

803
#-scl
804
(defun* directorize-pathname-host-device (pathname)
805
806
807
  (let* ((root (pathname-root pathname))
         (wild-root (wilden root))
         (absolute-pathname (merge-pathnames* pathname root))
808
         (separator (directory-separator-for-host root))
809
810
811
         (root-namestring (namestring root))
         (root-string
          (substitute-if #\/
812
813
                         #'(lambda (x) (or (eql x #\:)
                                           (eql x separator)))
814
815
                         root-namestring)))
    (multiple-value-bind (relative path filename)
816
        (component-name-to-pathname-components root-string :force-directory t)
817
818
819
820
821
822
      (declare (ignore relative filename))
      (let ((new-base
             (make-pathname :defaults root
                            :directory `(:absolute ,@path))))
        (translate-pathname absolute-pathname wild-root (wilden new-base))))))

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
#+scl
(defun* directorize-pathname-host-device (pathname)
  (let ((scheme (ext:pathname-scheme pathname))
	(host (pathname-host pathname))
	(port (ext:pathname-port pathname))
	(directory (pathname-directory pathname)))
    (flet ((not-unspecific (component)
	     (and (not (eq component :unspecific)) component)))
      (cond ((or (not-unspecific port)
		 (and (not-unspecific host) (plusp (length host)))
		 (not-unspecific scheme))
	     (let ((prefix ""))
	       (when (not-unspecific port)
		 (setf prefix (format nil ":~D" port)))
	       (when (and (not-unspecific host) (plusp (length host)))
		 (setf prefix (concatenate 'string host prefix)))
	       (setf prefix (concatenate 'string ":" prefix))
	       (when (not-unspecific scheme)
	       (setf prefix (concatenate 'string scheme prefix)))
	       (assert (and directory (eq (first directory) :absolute)))
	       (make-pathname :directory `(:absolute ,prefix ,@(rest directory))
			      :defaults pathname)))
	    (t
	     pathname)))))

848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
;;;; -------------------------------------------------------------------------
;;;; ASDF Interface, in terms of generic functions.
(defgeneric* find-system (system &optional error-p))
(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))
(defgeneric* component-operation-time (operation component))
(defgeneric* operation-description (operation component)
  (:documentation "returns a phrase that describes performing this operation
on this component, e.g. \"loading /a/b/c\".
You can put together sentences using this phrase."))

(defgeneric* system-source-file (system)
  (: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)
  (: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."))

(defgeneric* component-property (component property))

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

(defgeneric* version-satisfies (component version))

(defgeneric* find-component (base path)
  (:documentation "Finds the component with PATH starting from BASE module;
if BASE is nil, then the component is assumed to be a system."))

(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"))

(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
it as (cdr (component-visited-p op c)).
  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."))

(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.
  Starting with 2.006, TRAVERSE will store an integer in data,
so that nodes can be sorted in decreasing order of traversal."))


(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))

(defgeneric* traverse (operation component)
  (:documentation
"Generate and return a plan for performing OPERATION on COMPONENT.

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."))


;;;; -------------------------------------------------------------------------
;;; Methods in case of hot-upgrade. See https://bugs.launchpad.net/asdf/+bug/485687
(when *upgraded-p*
   (when (find-class 'module nil)
     (eval
      `(defmethod update-instance-for-redefined-class :after
           ((m module) added deleted plist &key)
         (declare (ignorable deleted plist))
         (when (or *asdf-verbose* *load-verbose*)
963
964
965
           (asdf-message
            #-genera "~&~@<; ~@; Updating ~A for ASDF ~A~@:>~%"
            #+genera "~&; Updating ~A for ASDF ~A~%" m ,(asdf-version)))
966
967
         (when (member 'components-by-name added)
           (compute-module-components-by-name m))
968
969
970
971
972
973
         (when (typep m 'system)
           (when (member 'source-file added)
             (%set-system-source-file
              (probe-asd (component-name m) (component-pathname m)) m)
             (when (equal (component-name m) "asdf")
               (setf (component-version m) *asdf-version*))))))))
974

975
976
;;;; -------------------------------------------------------------------------
;;;; Classes, Conditions
Daniel Barlow's avatar
Daniel Barlow committed
977

978
979
980
981
982
983
984
985
986
(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))

987
988
989
990
991
(declaim (ftype (function (t) t)
                format-arguments format-control
                error-name error-pathname error-condition
                duplicate-names-name
                error-component error-operation
992
                module-components module-components-by-name
993
994
995
996
                circular-dependency-components
                condition-arguments condition-form
                condition-format condition-location
                coerce-name)
997
998
999
         (ftype (function (t t) t) (setf module-components-by-name)))


Daniel Barlow's avatar
Daniel Barlow committed
1000
(define-condition formatted-system-definition-error (system-definition-error)
For faster browsing, not all history is shown. View entire blame