asdf.texinfo 189 KB
Newer Older
1
2
\input texinfo          @c -*- texinfo -*-
@c %**start of header
3
@setfilename asdf.info
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
4
@settitle ASDF Manual
5
6
@c %**end of header

7
8
@c We use @&key, etc to escape & from TeX in lambda lists --
@c so we need to define them for info as well.
9
@macro AallowOtherKeys
10
11
&allow-other-keys
@end macro
12
@macro Aoptional
13
14
&optional
@end macro
15
@macro Arest
16
17
&rest
@end macro
18
@macro Akey
19
20
&key
@end macro
21
@macro Abody
22
23
24
&body
@end macro

25
26
27
@c for install-info
@dircategory Software development
@direntry
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
28
* asdf: (asdf).           Another System Definition Facility (for Common Lisp)
29
30
@end direntry

31
@copying
32
33
This manual describes ASDF, a system definition facility
for Common Lisp programs and libraries.
34

35
36
37
You can find the latest version of this manual at
@url{http://common-lisp.net/project/asdf/asdf.html}.

38
ASDF Copyright @copyright{} 2001-2014 Daniel Barlow and contributors.
39

40
This manual Copyright @copyright{} 2001-2014 Daniel Barlow and contributors.
41

42
This manual revised @copyright{} 2009-2014 Robert P. Goldman and Francois-Rene Rideau.
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

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.

@end copying



@titlepage
68
@title ASDF: Another System Definition Facility
69

70
71
72
73
74
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
75

76
77
78
79
80
81
82
@c Output the table of contents at the beginning.
@contents

@c -------------------

@ifnottex

83
@node Top, Introduction, (dir), (dir)
84
@top asdf: another system definition facility
85

86
87
88
@insertcopying

@menu
89
90
* Introduction::
* Loading ASDF::
91
92
* Configuring ASDF::
* Using ASDF::
93
94
* Defining systems with defsystem::
* The object model of ASDF::
95
* Controlling where ASDF searches for systems::
96
97
98
99
100
* Controlling where ASDF saves compiled files::
* Error handling::
* Miscellaneous additional functionality::
* Getting the latest version::
* FAQ::
101
* TODO list::
102
103
104
105
* Inspiration::
* Concept Index::
* Function and Class Index::
* Variable Index::
106

107
108
@c @detailmenu
@c  --- The Detailed Node Listing ---
109

110
@c Defining systems with defsystem
111

112
113
114
115
@c * The defsystem form::
@c * A more involved example::
@c * The defsystem grammar::
@c * Other code in .asd files::
116

117
@c The object model of ASDF
118

119
120
@c * Operations::
@c * Components::
121
@c * Functions::
122

123
@c Operations
124

125
126
@c * Predefined operations of ASDF::
@c * Creating new operations::
127

128
@c Components
129

130
131
132
@c * Common attributes of components::
@c * Pre-defined subclasses of component::
@c * Creating new component types::
133

134
@c properties
135

136
137
@c * Pre-defined subclasses of component::
@c * Creating new component types::
138

139
@c @end detailmenu
140
141
142
143
144
145
@end menu

@end ifnottex

@c -------------------

146
@node Introduction, Loading ASDF, Top, Top
147
148
@comment  node-name,  next,  previous,  up
@chapter Introduction
Robert P. Goldman's avatar
Robert P. Goldman committed
149
150
151
152
153
154
@cindex ASDF-related features
@vindex *features*
@cindex Testing for ASDF
@cindex ASDF versions
@cindex :asdf
@cindex :asdf2
155
@cindex :asdf3
156

157
158
159
160
161
162
163
164
165
166
ASDF is Another System Definition Facility:
a tool for specifying how systems of Common Lisp software
are comprised of components (sub-systems and files),
and how to operate on these components in the right order
so that they can be compiled, loaded, tested, etc.

ASDF presents three faces:
one for users of Common Lisp software who want to reuse other people's code,
one for writers of Common Lisp software who want to specify how to build their systems,
one for implementers of Common Lisp extensions who want to extend the build system.
Robert P. Goldman's avatar
Robert P. Goldman committed
167
@xref{Using ASDF,,Loading a system},
168
to learn how to use ASDF to load a system.
Robert P. Goldman's avatar
Robert P. Goldman committed
169
@xref{Defining systems with defsystem},
170
to learn how to define a system of your own.
171
@xref{The object model of ASDF}, for a description of
Robert P. Goldman's avatar
Robert P. Goldman committed
172
the ASDF internals and how to extend ASDF.
173

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
174
@emph{Nota Bene}:
175
We have released ASDF 2.000 on May 31st 2010,
176
and ASDF 3.0.0 on May 15th 2013.
177
Releases of ASDF 2 and later have since then been included
178
179
180
in all actively maintained CL implementations that used to bundle ASDF 1,
plus some implementations that didn't use to,
and has been made to work with all actively used CL implementations and a few more.
181
@xref{FAQ,,``What has changed between ASDF 1 and ASDF 2?''}.
182
183
184
185
Furthermore, it is possible to upgrade from ASDF 1 to ASDF 2 or ASDF 3 on the fly.
For this reason, we have stopped supporting ASDF 1 and ASDF 2.
If you are using ASDF 1 or ASDF 2 and are experiencing any kind of issues or limitations,
we recommend you upgrade to ASDF 3
186
--- and we explain how to do that. @xref{Loading ASDF}.
187
188
189
190
(In the context of compatibility requirements,
ASDF 2.27, released on Feb 1st 2013, and further 2.x releases up to 2.33,
count as pre-releases of ASDF 3, and define the :asdf3 feature;
still, please use the latest release).
191
192
193
194
195
196
197
198

Also note that ASDF is not to be confused with ASDF-Install.
ASDF-Install is not part of ASDF, but a separate piece of software.
ASDF-Install is also unmaintained and obsolete.
We recommend you use Quicklisp instead,
which works great and is being actively maintained.
If you want to download software from version control instead of tarballs,
so you may more easily modify it, we recommend clbuild.
199

200

201
@node Loading ASDF, Configuring ASDF, Introduction, Top
202
@comment  node-name,  next,  previous,  up
203
@chapter Loading ASDF
204
@vindex *central-registry*
205
@cindex link farm
206
@findex load-system
207
@findex require-system
208
209
210
211
212
@findex compile-system
@findex test-system
@cindex system directory designator
@findex operate
@findex oos
213

214
@c @menu
215
@c * Installing ASDF::
216
217
218
@c @end menu


219
220
@section Loading a pre-installed ASDF

221
222
Most recent Lisp implementations include a copy of ASDF 3,
or at least ASDF 2.
223
224
225
You can usually load this copy using Common Lisp's @code{require} function:

@lisp
226
(require "asdf")
227
228
@end lisp

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
229
As of the writing of this manual,
230
231
232
233
the following implementations provide ASDF 3 this way:
abcl allegro ccl clisp cmucl ecl mkcl sbcl.
The following implementation only provide ASDF 2:
lispworks mkcl mocl xcl.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
234
The following implementation doesn't provide it yet but will in an upcoming release:
235
scl.
236
237
The following implementations are obsolete, not actively maintained,
and most probably will never bundle it:
238
cormanlisp gcl genera mcl.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
239

240
If the implementation you are using doesn't provide ASDF 2 or ASDF 3,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
241
242
243
244
see @pxref{Loading ASDF,,Loading an otherwise installed ASDF} below.
If that implementation is still actively maintained,
you may also send a bug report to your Lisp vendor and complain
about their failing to provide ASDF.
245

246
247
248
249
NB: all implementations except clisp also accept
@code{(require "ASDF")}, @code{(require 'asdf)} and @code{(require :asdf)}.
For portability's sake, you probably want to use @code{(require "asdf")}.

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

@section Checking whether ASDF is loaded

To check whether ASDF is properly loaded in your current Lisp image,
you can run this form:

@lisp
(asdf:asdf-version)
@end lisp

If it returns a string,
that is the version of ASDF that is currently installed.

If it raises an error,
then either ASDF is not loaded, or
you are using an old version of ASDF.

You can check whether an old version is loaded
by checking if the ASDF package is present.
The form below will allow you to programmatically determine
whether a recent version is loaded, an old version is loaded,
or none at all:

@lisp
274
(when (find-package :asdf)
275
276
277
278
  (let ((ver (symbol-value (or (find-symbol (string :*asdf-version*) :asdf)
                               (find-symbol (string :*asdf-revision*) :asdf)))))
    (etypecase ver
      (string ver)
279
280
      (cons (with-output-to-string (s)
              (loop for (n . m) on ver do (princ n s) (when m (princ "." s)))))
281
      (null "1.0"))))
282
283
@end lisp

284
If it returns @code{nil} then ASDF is not installed.
285
286
287
Otherwise it should return a string.
If it returns @code{"1.0"}, then it can actually be
any version before 1.77 or so, or some buggy variant of 1.x.
288

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
289
290
291
292
If you are experiencing problems with ASDF,
please try upgrading to the latest released version,
using the method below,
before you contact us and raise an issue.
293
294


295
296
@section Upgrading ASDF

297
If your implementation provides ASDF 3 or later,
298
299
300
301
302
you only need to @code{(require "asdf")}:
ASDF will automatically look whether an updated version of itself is available
amongst the regularly configured systems, before it compiles anything else.
See @pxref{Configuring ASDF} below.

303
If your implementation does provide ASDF 2 or later,
304
but not ASDF 3 or later,
305
and you want to upgrade to a more recent version,
306
307
308
you need to install and configure your ASDF as above,
and additionally, you need to explicitly tell ASDF to load itself,
right after you require your implementation's old ASDF 2:
309
310

@lisp
311
(require "asdf")
312
313
314
315
(asdf:load-system :asdf)
@end lisp

If on the other hand, your implementation only provides an old ASDF,
316
317
318
you will require a special configuration step and an old-style loading.
Take special attention to not omit the trailing directory separator
@code{/} at the end of your pathname:
319
320

@lisp
321
(require "asdf")
322
323
324
325
(push #p"@var{/path/to/new/asdf/}" asdf:*central-registry*)
(asdf:oos 'asdf:load-op :asdf)
@end lisp

326
Note that ASDF 1 won't redirect its output files,
327
328
329
330
331
332
333
or at least won't do it according to your usual ASDF 2 configuration.
You therefore need write access on the directory
where you install the new ASDF,
and make sure you're not using it
for multiple mutually incompatible implementations.
At worst, you may have to have multiple copies of the new ASDF,
e.g. one per implementation installation, to avoid clashes.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
334
335
336
Note that to our knowledge all implementations that provide ASDF
provide ASDF 2 in their latest release, so
you may want to upgrade your implementation rather than go through that hoop.
337

338
339
340
341
342
Finally, if you are using an unmaintained implementation
that does not provide ASDF at all,
see @pxref{Loading ASDF,,Loading an otherwise installed ASDF} below.

Note that there are some limitations to upgrading ASDF:
343
344
@itemize
@item
345
Previously loaded ASDF extensions become invalid, and will need to be reloaded.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
346
This applies to e.g. CFFI-Grovel, or to hacks used by ironclad, etc.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
347
348
Since it isn't possible to automatically detect what extensions are present
that need to be invalidated,
349
ASDF will actually invalidate all previously loaded systems
350
351
352
353
354
355
356
when it is loaded on top of a forward-incompatible ASDF version
(as per @code{asdf/upgrade::*oldest-forward-compatible-asdf-version*}
which is 2.33 at the time of this writing).
Furthermore, starting with ASDF 3 (2.27 or later),
this self-upgrade will be automatically attempted as the first step
to any system operation, to avoid any possibility of
a catastrophic attempt to self-upgrade in midflight.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
357

358
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
359
360
361
For this an many other reasons,
it important reason to load, configure and upgrade ASDF (if needed)
as one of the very first things done by your build and startup scripts.
362
Until all implementations provide ASDF 3 or later,
363
it is safer if you upgrade ASDF and its extensions as a special step
364
at the very beginning of whatever script you are running,
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
365
366
367
368
before you start using ASDF to load anything else;
even afterwards, it is still a good idea, to avoid having to
load and reload code twice as it gets invalidated.

369
@item
370
Until all implementations provide ASDF 3 or later,
371
it is unsafe to upgrade ASDF as part of loading a system
372
373
374
375
that depends on a more recent version of ASDF,
since the new one might shadow the old one while the old one is running,
and the running old one will be confused
when extensions are loaded into the new one.
376
In the meantime, we recommend that your systems should @emph{not} specify
377
378
379
380
381
382
383
384
@code{:depends-on (:asdf)}, or @code{:depends-on ((:version :asdf "2.010"))},
but instead that they check that a recent enough ASDF is installed,
with such code as:
@example
(unless (or #+asdf2 (asdf:version-satisfies
                     (asdf:asdf-version) *required-asdf-version*))
  (error "FOO requires ASDF ~A or later." *required-asdf-version*))
@end example
385
@item
386
Until all implementations provide ASDF 3 or later,
387
388
389
390
391
it is unsafe for a system to transitively depend on ASDF
and not directly depend on ASDF;
if any of the system you use either depends-on asdf,
system-depends-on asdf, or transitively does,
you should also do as well.
392
393
@end itemize

394

395
396
397
@section Loading an otherwise installed ASDF

If your implementation doesn't include ASDF,
398
399
if for some reason the upgrade somehow fails,
does not or cannot apply to your case,
400
401
402
403
404
405
you will have to install the file @file{asdf.lisp}
somewhere and load it with:

@lisp
(load "/path/to/your/installed/asdf.lisp")
@end lisp
406

407
The single file @file{asdf.lisp} is all you normally need to use ASDF.
408

409
You can extract this file from latest release tarball on the
410
@url{http://common-lisp.net/project/asdf/,ASDF website}.
411
If you are daring and willing to report bugs, you can get
412
the latest and greatest version of ASDF from its git repository.
413
414
415
416
417
418
419
@xref{Getting the latest version}.

For maximum convenience you might want to have ASDF loaded
whenever you start your Lisp implementation,
for example by loading it from the startup script or dumping a custom core
--- check your Lisp implementation's manual for details.

420

421
422
@node Configuring ASDF, Using ASDF, Loading ASDF, Top
@comment  node-name,  next,  previous,  up
423
424
425
426
427
428
429
430

@chapter Configuring ASDF

@section Configuring ASDF to find your systems

So it may compile and load your systems, ASDF must be configured to find
the @file{.asd} files that contain system definitions.

431
Since ASDF 2, the preferred way to configure where ASDF finds your systems is
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
432
433
434
the @code{source-registry} facility,
fully described in its own chapter of this manual.
@xref{Controlling where ASDF searches for systems}.
435
436
437

The default location for a user to install Common Lisp software is under
@file{~/.local/share/common-lisp/source/}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
438
439
If you install software there (it can be a symlink),
you don't need further configuration.
440
441
If you're installing software yourself at a location that isn't standard,
you have to tell ASDF where you installed it. See below.
442
If you're using some tool to install software (e.g. Quicklisp),
443
444
445
the authors of that tool should already have configured ASDF.

The simplest way to add a path to your search path,
446
say @file{/home/luser/.asd-link-farm/}
447
448
is to create the directory
@file{~/.config/common-lisp/source-registry.conf.d/}
449
450
and there create a file with any name of your choice,
and with the type @file{conf},
451
for instance @file{42-asd-link-farm.conf}
452
453
containing the line:

454
@kbd{(:directory "/home/luser/.asd-link-farm/")}
455

456
If you want all the subdirectories under @file{/home/luser/lisp/}
457
458
to be recursively scanned for @file{.asd} files, instead use:

459
@kbd{(:tree "/home/luser/lisp/")}
460
461
462
463

Note that your Operating System distribution or your system administrator
may already have configured system-managed libraries for you.

464
465
466
467
468
The required @file{.conf} extension allows you to have disabled files
or editor backups (ending in @file{~}), and works portably
(for instance, it is a pain to allow both empty and non-empty extension on CLISP).
Excluded are files the name of which start with a @file{.} character.
It is customary to start the filename with two digits
469
470
471
472
473
that specify the order in which the directories will be scanned.

ASDF will automatically read your configuration
the first time you try to find a system.
You can reset the source-registry configuration with:
474

475
476
477
478
479
480
481
482
@lisp
(asdf:clear-source-registry)
@end lisp

And you probably should do so before you dump your Lisp image,
if the configuration may change
between the machine where you save it at the time you save it
and the machine you resume it at the time you resume it.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
483
484
Actually, you should use @code{(asdf:clear-configuration)}
before you dump your Lisp image, which includes the above.
485
486


487
@section Configuring ASDF to find your systems --- old style
488
489
490
491
492
493
494
495
496
497
498
499

The old way to configure ASDF to find your systems is by
@code{push}ing directory pathnames onto the variable
@code{asdf:*central-registry*}.

You must configure this variable between the time you load ASDF
and the time you first try to use it.
Loading and configuring ASDF presumably happen
as part of some initialization script that builds or starts
your Common Lisp software system.
(For instance, some SBCL users used to put it in their @file{~/.sbclrc}.)

500
The @code{asdf:*central-registry*} is empty by default in ASDF 2 or ASDF 3,
501
502
503
504
505
506
507
508
509
510
511
but is still supported for compatibility with ASDF 1.
When used, it takes precedence over the above source-registry@footnote{
It is possible to further customize
the system definition file search.
That's considered advanced use, and covered later:
search forward for
@code{*system-definition-search-functions*}.
@xref{Defining systems with defsystem}.}.

For instance, if you wanted ASDF to find the @file{.asd} file
@file{/home/me/src/foo/foo.asd} your initialization script
512
could after it loads ASDF with @code{(require "asdf")}
513
514
515
516
517
518
519
520
521
configure it with:

@lisp
(push "/home/me/src/foo/" asdf:*central-registry*)
@end lisp

Note the trailing slash: when searching for a system,
ASDF will evaluate each entry of the central registry
and coerce the result to a pathname@footnote{
522
523
ASDF will indeed call @code{eval} on each entry.
It will also skip entries that evaluate to @code{nil}.
524
525

Strings and pathname objects are self-evaluating,
526
in which case the @code{eval} step does nothing;
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
but you may push arbitrary SEXP onto the central registry,
that will be evaluated to compute e.g. things that depend
on the value of shell variables or the identity of the user.

The variable @code{asdf:*central-registry*} is thus a list of
``system directory designators''.
A @dfn{system directory designator} is a form
which will be evaluated whenever a system is to be found,
and must evaluate to a directory to look in.
By ``directory'' here, we mean
``designator for a pathname with a supplied DIRECTORY component''.
}
at which point the presence of the trailing directory name separator
is necessary to tell Lisp that you're discussing a directory
rather than a file.

Typically, however, there are a lot of @file{.asd} files, and
a common idiom was to have to put
a bunch of @emph{symbolic links} to @file{.asd} files
in a common directory
and push @emph{that} directory (the ``link farm'')
to the
@code{asdf:*central-registry*}
instead of pushing each of the many involved directories
to the @code{asdf:*central-registry*}.
ASDF knows how to follow such @emph{symlinks}
to the actual file location when resolving the paths of system components
554
555
(on Windows, you can use Windows shortcuts instead of POSIX symlinks;
if you try aliases under MacOS, we are curious to hear about your experience).
556
557
558

For example, if @code{#p"/home/me/cl/systems/"} (note the trailing slash)
is a member of @code{*central-registry*}, you could set up the
559
560
561
562
563
564
565
566
system @var{foo} for loading with asdf with the following
commands at the shell:

@example
$ cd /home/me/cl/systems/
$ ln -s ~/src/foo/foo.asd .
@end example

567
568
569
570
This old style for configuring ASDF is not recommended for new users,
but it is supported for old users, and for users who want to programmatically
control what directories are added to the ASDF search path.

571

572
@section Configuring where ASDF stores object files
573
@findex clear-output-translations
574
575
576
577
578
579
580
581
582
583
584
585

ASDF lets you configure where object files will be stored.
Sensible defaults are provided and
you shouldn't normally have to worry about it.

This allows the same source code repository may be shared
between several versions of several Common Lisp implementations,
between several users using different compilation options
and without write privileges on shared source directories, etc.
This also allows to keep source directories uncluttered
by plenty of object files.

586
Starting with ASDF 2, the @code{asdf-output-translations} facility
587
was added to ASDF itself, that controls where object files will be stored.
588
This facility is fully described in a chapter of this manual,
589
@ref{Controlling where ASDF saves compiled files}.
590
591
592
593
594
595

The simplest way to add a translation to your search path,
say from @file{/foo/bar/baz/quux/}
to @file{/where/i/want/my/fasls/}
is to create the directory
@file{~/.config/common-lisp/asdf-output-translations.conf.d/}
596
and there create a file with any name of your choice and the type @file{conf},
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
for instance @file{42-bazquux.conf}
containing the line:

@kbd{("/foo/bar/baz/quux/" "/where/i/want/my/fasls/")}

To disable output translations for source under a given directory,
say @file{/toto/tata/}
you can create a file @file{40-disable-toto.conf}
with the line:

@kbd{("/toto/tata/")}

To wholly disable output translations for all directories,
you can create a file @file{00-disable.conf}
with the line:

613
@kbd{(t t)}
614
615
616
617
618

Note that your Operating System distribution or your system administrator
may already have configured translations for you.
In absence of any configuration, the default is to redirect everything
under an implementation-dependent subdirectory of @file{~/.cache/common-lisp/}.
619
@xref{Controlling where ASDF searches for systems}, for full details.
620

621
622
623
624
625
The required @file{.conf} extension allows you to have disabled files
or editor backups (ending in @file{~}), and works portably
(for instance, it is a pain to allow both empty and non-empty extension on CLISP).
Excluded are files the name of which start with a @file{.} character.
It is customary to start the filename with two digits
626
627
628
629
630
that specify the order in which the directories will be scanned.

ASDF will automatically read your configuration
the first time you try to find a system.
You can reset the source-registry configuration with:
631
632

@lisp
633
(asdf:clear-output-translations)
634
635
@end lisp

636
637
638
639
And you probably should do so before you dump your Lisp image,
if the configuration may change
between the machine where you save it at the time you save it
and the machine you resume it at the time you resume it.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
640
641
(Once again, you should use @code{(asdf:clear-configuration)}
before you dump your Lisp image, which includes the above.)
642

643
Finally note that before ASDF 2,
644
645
646
647
other ASDF add-ons offered the same functionality,
each in subtly different and incompatible ways:
ASDF-Binary-Locations, cl-launch, common-lisp-controller.
ASDF-Binary-Locations is now not needed anymore and should not be used.
648
cl-launch 3.000 and common-lisp-controller 7.2 have been updated
649
to just delegate this functionality to ASDF.
650

651
652
@node Using ASDF, Defining systems with defsystem, Configuring ASDF, Top
@comment  node-name,  next,  previous,  up
653

654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680

@section Resetting Configuration

When you dump and restore an image, or when you tweak your configuration,
you may want to reset the ASDF configuration.
For that you may use the following function:

@defun clear-configuration
   undoes any ASDF configuration,
   regarding source-registry or output-translations.
@end defun

If you use SBCL, CMUCL or SCL, you may use this snippet
so that the ASDF configuration be cleared automatically as you dump an image:

@example
#+(or cmu sbcl scl)
(pushnew 'clear-configuration
         #+(or cmu scl) ext:*before-save-initializations*
         #+sbcl sb-ext:*save-hooks*)
@end example

For compatibility with all Lisp implementations, however,
you might want instead your build script to explicitly call
@code{(asdf:clear-configuration)} at an appropriate moment before dumping.


681
682
683
684
685
686
@chapter Using ASDF

@section Loading a system

The system @var{foo} is loaded (and compiled, if necessary)
by evaluating the following Lisp form:
687
688

@example
689
(asdf:load-system :@var{foo})
690
691
@end example

692
On some implementations (namely recent versions of
693
694
ABCL, Allegro CL, Clozure CL, CMUCL, ECL, GNU CLISP,
LispWorks, MKCL, SBCL and XCL),
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
695
696
697
698
699
700
701
ASDF hooks into the @code{CL:REQUIRE} facility
and you can just use:

@example
(require :@var{foo})
@end example

702
703
In older versions of ASDF, you needed to use
@code{(asdf:oos 'asdf:load-op :@var{foo})}.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
704
If your ASDF is too old to provide @code{asdf:load-system} though
705
we recommend that you upgrade to ASDF 3.
706
@xref{Loading ASDF,,Loading an otherwise installed ASDF}.
707

708
709
710
711
712
713
714
715
716
717
718
719
720
Note the name of a system is specified as a string or a symbol,
typically a keyword.
If a symbol (including a keyword), its name is taken and lowercased.
The name must be a suitable value for the @code{:name} initarg
to @code{make-pathname} in whatever filesystem the system is to be found.
The lower-casing-symbols behaviour is unconventional,
but was selected after some consideration.
Observations suggest that the type of systems we want to support
either have lowercase as customary case (unix, mac, windows)
or silently convert lowercase to uppercase (lpns),
so this makes more sense than attempting to use @code{:case :common},
which is reported not to work on some implementations

721

722
@section Other Operations
723

724
725
ASDF provides three commands for the most common system operations:
@code{load-system}, @code{compile-system} or @code{test-system}.
726
727
It also provides @code{require-system}, a version of @code{load-system}
that skips trying to update systems that are already loaded.
728

729
730
731
732
733
734
Because ASDF is an extensible system
for defining @emph{operations} on @emph{components},
it also provides a generic function @code{operate}
(which is usually abbreviated by @code{oos}).
You'll use @code{oos} whenever you want to do something beyond
compiling, loading and testing.
735

736
737
738
739
Output from ASDF and ASDF extensions are supposed to be sent
to the CL stream @code{*standard-output*},
and so rebinding that stream around calls to @code{asdf:operate}
should redirect all output from ASDF operations.
740

741
742
Reminder: before ASDF can operate on a system, however,
it must be able to find and load that system's definition.
743
@xref{Configuring ASDF,,Configuring ASDF to find your systems}.
744

745
746
@findex already-loaded-systems

747
748
For the advanced users, note that
@code{require-system} calls @code{load-system}
749
750
with keyword arguments @code{:force-not (already-loaded-systems)}.
@code{already-loaded-systems} returns a list of the names of loaded systems.
751
752
753
@code{load-system} applies @code{operate} with the operation from
@code{*load-system-operation*}, which by default is @code{load-op},
the system, and any provided keyword arguments.
754

755
756
757
758
759
@section Summary

To use ASDF:

@itemize
760
@item
761
Load ASDF itself into your Lisp image, either through
762
@code{(require "asdf")} or else through
763
@code{(load "/path/to/asdf.lisp")}.
764

765
@item
766
767
Make sure ASDF can find system definitions
thanks to proper source-registry configuration.
768

769
@item
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
770
Load a system with @code{(asdf:load-system :my-system)}
771
or use some other operation on some system of your choice.
772
773
774

@end itemize

775
@section Moving on
776

777
778
779
780
781
That's all you need to know to use ASDF to load systems written by others.
The rest of this manual deals with writing system definitions
for Common Lisp software you write yourself,
including how to extend ASDF to define new operation and component types.

782

783
@node Defining systems with defsystem, The object model of ASDF, Using ASDF, Top
784
785
786
787
788
789
790
791
@comment  node-name,  next,  previous,  up
@chapter Defining systems with defsystem

This chapter describes how to use asdf to define systems and develop
software.


@menu
792
793
794
795
* The defsystem form::
* A more involved example::
* The defsystem grammar::
* Other code in .asd files::
796
* The package-system extension::
797
798
799
800
801
802
@end menu

@node  The defsystem form, A more involved example, Defining systems with defsystem, Defining systems with defsystem
@comment  node-name,  next,  previous,  up
@section The defsystem form

803
804
805
806
807
808
Systems can be constructed programmatically
by instantiating components using @code{make-instance}.
Most of the time, however, it is much more practical to use
a static @code{defsystem} form.
This section begins with an example of a system definition,
then gives the full grammar of @code{defsystem}.
809

810
811
Let's look at a simple system.
This is a complete file that would
812
usually be saved as @file{hello-lisp.asd}:
813
814

@lisp
815
(in-package :asdf)
816

817
(defsystem "hello-lisp"
818
  :description "hello-lisp: a sample Lisp system."
819
  :version "0.2.1"
820
821
822
823
824
  :author "Joe User <joe@@example.com>"
  :licence "Public Domain"
  :components ((:file "packages")
               (:file "macros" :depends-on ("packages"))
               (:file "hello" :depends-on ("macros"))))
825
826
827
828
829
@end lisp

Some notes about this example:

@itemize
830
831

@item
832
833
834
835
The file starts with an @code{in-package} form
to use package @code{asdf}.
You could instead start your definition by using
a qualified name @code{asdf:defsystem}.
836

837
@item
838
839
840
841
842
843
844
845
846
847
848
849
850
If in addition to simply using @code{defsystem},
you are going to define functions,
create ASDF extension, globally bind symbols, etc.,
it is recommended that to avoid namespace pollution between systems,
you should create your own package for that purpose,
for instance replacing the above @code{(in-package :asdf)} with:

@lisp
(defpackage :foo-system
  (:use :cl :asdf))

(in-package :foo-system)
@end lisp
851
852

@item
853
854
855
The @code{defsystem} form defines a system named @code{hello-lisp}
that contains three source files:
@file{packages}, @file{macros} and @file{hello}.
856

857
858
859
860
861
862
863
@item
The file @file{macros} depends on @file{packages}
(presumably because the package it's in is defined in @file{packages}),
and the file @file{hello} depends on @file{macros}
(and hence, transitively on @file{packages}).
This means that ASDF will compile and load @file{packages} and @file{macros}
before starting the compilation of file @file{hello}.
864
865

@item
866
867
868
869
870
871
872
873
The files are located in the same directory
as the file with the system definition.
ASDF resolves symbolic links (or Windows shortcuts)
before loading the system definition file and
stores its location in the resulting system@footnote{
It is possible, though almost never necessary, to override this behaviour.}.
This is a good thing because the user can move the system sources
without having to edit the system definition.
874

875
876
877
878
@c FIXME: Should have cross-reference to "Version specifiers" in the
@c defsystem grammar, but the cross-referencing is so broken by
@c insufficient node breakdown that I have not put one in.
@item
879
880
881
882
883
884
885
Make sure you know how the @code{:version} numbers will be parsed!
They are parsed as period-separated lists of integers.
I.e., in the example, @code{0.2.1} is to be interpreted,
roughly speaking, as @code{(0 2 1)}.
In particular, version @code{0.2.1}
is interpreted the same as @code{0.0002.1} and
is strictly version-less-than version @code{0.20.1},
886
even though the two are the same when interpreted as decimal fractions.
887
888
889
890
Instead of a string representing the version,
the @code{:version} argument can be an expression that is resolved to
such a string using the following trivial domain-specific language:
in addition to being a literal string, it can be an expression of the form
891
@code{(:read-file-form <pathname-or-string> :at <access-at-specifier>)},
892
which will be resolved by reading a form in the specified pathname
893
(read as a subpathname of the current system if relative or a unix-namestring).
894
895
896
You may use a @code{uiop:access-at} specifier
with the (optional) @code{:at} keyword,
by default the specifier is @code{0}, meaning the first form is returned.
897

898
899
@cindex :version

900
901
902
903
904
905
906
907
908
909
910
@end itemize

@node  A more involved example, The defsystem grammar, The defsystem form, Defining systems with defsystem
@comment  node-name,  next,  previous,  up
@section A more involved example

Let's illustrate some more involved uses of @code{defsystem} via a
slightly convoluted example:

@lisp
(defsystem "foo"
911
  :version "1.0.0"
912
913
914
915
916
917
918
919
920
  :components ((:module "mod"
                            :components ((:file "bar")
                                                  (:file"baz")
                                                  (:file "quux"))
                            :perform (compile-op :after (op c)
                                                  (do-something c))
                            :explain (compile-op :after (op c)
                                            (explain-something c)))
                         (:file "blah")))
921
922
@end lisp

923
924
925
926
927
928
929
The @code{:module} component named @code{"mod"} is a collection of three files,
which will be located in a subdirectory of the main code directory named
@file{mod} (this location can be overridden; see the discussion of the
@code{:pathname} option in @ref{The defsystem grammar}).

The method-form tokens provide a shorthand for defining methods on
particular components.  This part
930
931

@lisp
932
933
934
935
                :perform (compile-op :after (op c)
                          (do-something c))
                :explain (compile-op :after (op c)
                          (explain-something c))
936
937
938
939
940
941
@end lisp

has the effect of

@lisp
(defmethod perform :after ((op compile-op) (c (eql ...)))
942
           (do-something c))
943
(defmethod explain :after ((op compile-op) (c (eql ...)))
944
           (explain-something c))
945
946
@end lisp

947
where @code{...} is the component in question.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
948
In this case @code{...} would expand to something like
949
950

@lisp
951
(find-component "foo" "mod")
952
953
954
955
956
957
958
959
960
961
962
963
964
965
@end lisp

For more details on the syntax of such forms, see @ref{The defsystem
grammar}.
For more details on what these methods do, @pxref{Operations} in
@ref{The object model of ASDF}.

@c The following plunge into the weeds is not appropriate in this
@c location. [2010/10/03:rpg]
@c note that although this also supports @code{:before} methods,
@c they may not do what you want them to ---
@c a @code{:before} method on perform @code{((op compile-op) (c (eql ...)))}
@c will run after all the dependencies and sub-components have been processed,
@c but before the component in question has been compiled.
966

967
@node  The defsystem grammar, Other code in .asd files, A more involved example, Defining systems with defsystem
968
969
970
@comment  node-name,  next,  previous,  up
@section The defsystem grammar

971
972
973
@c FIXME: @var typesetting not consistently used here.  We should either expand
@c its use to everywhere, or we should kill it everywhere.

974

975
@example
976
977
system-definition := ( defsystem system-designator @var{system-option}* )

978
979
system-option := :defsystem-depends-on system-list
                 | :weakly-depends-on @var{system-list}
980
                 | :class class-name (see discussion below)
981
982
983
984
985
                 | module-option
                 | option

module-option := :components component-list
                 | :serial [ t | nil ]
986

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
987
option :=
988
        | :pathname pathname-specifier
989
        | :default-component-class class-name
990
        | :perform method-form
991
        | :explain method-form
992
        | :output-files method-form
993
        | :operation-done-p method-form
994
        | :if-feature feature-expression
995
996
        | :depends-on ( @var{dependency-def}* )
        | :in-order-to ( @var{dependency}+ )
997

998

999
1000
system-list := ( @var{simple-component-name}* )

1001
component-list := ( @var{component-def}* )
1002

1003
component-def  := ( component-type simple-component-name @var{option}* )
1004

1005
component-type := :module | :file | :static-file | other-component-type
1006

1007
other-component-type := symbol-by-name (@pxref{The defsystem grammar,,Component types})
1008

1009
1010
# This is used in :depends-on, as opposed to ``dependency,''
# which is used in :in-order-to
Gary King's avatar
Gary King committed
1011
dependency-def := simple-component-name
1012
1013
               | ( :feature @var{feature-expression} dependency-def )
               | ( :version simple-component-name version-specifier )
Gary King's avatar
Gary King committed
1014

1015
# ``dependency'' is used in :in-order-to, as opposed to
1016
# ``dependency-def''
1017
1018
dependency := (dependent-op @var{requirement}+)
requirement := (required-op @var{required-component}+)
1019
dependent-op := operation-name
1020
required-op := operation-name
Gary King's avatar
Gary King committed
1021
1022
1023

simple-component-name := string
                      |  symbol
1024

1025
1026
pathname-specifier := pathname | string | symbol

1027
method-form := (operation-name qual lambda-list @Arest body)
1028
qual := method qualifier
1029
1030

component-dep-fail-option := :fail | :try-next | :ignore
1031
1032
1033

feature-expression := keyword | (:and @var{feature-expression}*)
                      | (:or @var{feature-expression}*) | (:not @var{feature-expression})
1034
@end example
1035

1036

1037
1038
@subsection Component names

1039
1040
Component names (@code{simple-component-name})
may be either strings or symbols.
1041

1042
@subsection Component types
1043
1044
1045
1046
1047
1048
1049

Component type names, even if expressed as keywords, will be looked up
by name in the current package and in the asdf package, if not found in
the current package.  So a component type @code{my-component-type}, in
the current package @code{my-system-asd} can be specified as
@code{:my-component-type}, or @code{my-component-type}.

1050
1051
1052
@code{system} and its subclasses are @emph{not}
allowed as component types for such children components.

1053
1054
@subsection System class names

1055
1056
1057
1058
A system class name will be looked up
in the same way as a Component type (see above),
except that only @code{system} and its subclasses are allowed.
Typically, one will not need to specify a system
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
class name, unless using a non-standard system class defined in some
ASDF extension, typically loaded through @code{DEFSYSTEM-DEPENDS-ON},
see below.  For such class names in the ASDF package, we recommend that
the @code{:class} option be specified using a keyword symbol, such as

@example
:class :MY-NEW-SYSTEM-SUBCLASS
@end example

This practice will ensure that package name conflicts are avoided.
Otherwise, the symbol @code{MY-NEW-SYSTEM-SUBCLASS} will be read into
the current package @emph{before} it has been exported from the ASDF
extension loaded by @code{:defsystem-depends-on}, causing a name
conflict in the current package.

1074
@subsection Defsystem depends on
1075
@cindex :defsystem-depends-on
1076
1077
1078
1079
1080
1081
1082

The @code{:defsystem-depends-on} option to @code{defsystem} allows the
programmer to specify another ASDF-defined system or set of systems that
must be loaded @emph{before} the system definition is processed.
Typically this is used to load an ASDF extension that is used in the
system definition.

1083
@subsection Weakly depends on
1084
1085
@cindex :weakly-depends-on

1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
We do @emph{NOT} recommend you use this feature.
If you are tempted to write a system @var{foo}
that weakly-depends-on a system @var{bar},
we recommend that you should instead
write system @var{foo} in a parametric way,
and offer some special variable and/or some hook to specialize its behavior;
then you should write a system @var{foo+bar}
that does the hooking of things together.

The (deprecated) @code{:weakly-depends-on} option to @code{defsystem}
allows the programmer to specify another ASDF-defined system or set of systems
that ASDF should @emph{try} to load,
but need not load in order to be successful.
Typically this is used if there are a number of systems
that, if present, could provide additional functionality,
but which are not necessary for basic function.
1102

1103
1104
1105
1106
Currently, although it is specified to be an option only to @code{defsystem},
this option is accepted at any component, but it probably
only makes sense at the @code{defsystem} level.
Programmers are cautioned not
1107
1108
1109
to use this component option except at the @code{defsystem} level, as
this anomalous behavior may be removed without warning.

1110
1111
1112
1113
1114
1115
1116
1117
Finally, you might look into the @code{asdf-system-connections} extension,
that will let you define additional code to be loaded
when two systems are simultaneously loaded.
It may or may not be considered good style, but at least it can be used
in a way that has deterministic behavior independent of load order,
unlike @code{weakly-depends-on}.


1118
@subsection Pathname specifiers
1119
@cindex pathname specifiers
1120

1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
A pathname specifier (@code{pathname-specifier})
may be a pathname, a string or a symbol.
When no pathname specifier is given for a component,
which is the usual case, the component name itself is used.

If a string is given, which is the usual case,
the string will be interpreted as a Unix-style pathname
where @code{/} characters will be interpreted as directory separators.
Usually, Unix-style relative pathnames are used
(i.e. not starting with @code{/}, as opposed to absolute pathnames);
they are relative to the path of the parent component.
Finally, depending on the @code{component-type},
the pathname may be interpreted as either a file or a directory,
and if it's a file,
a file type may be added corresponding to the @code{component-type},
or else it will be extracted from the string itself (if applicable).

For instance, the @code{component-type} @code{:module}
wants a directory pathname, and so a string @code{"foo/bar"}
will be interpreted as the pathname @file{#p"foo/bar/"}.
On the other hand, the @code{component-type} @code{:file}
wants a file of type @code{lisp}, and so a string @code{"foo/bar"}
will be interpreted as the pathname @file{#p"foo/bar.lisp"},
and a string @code{"foo/bar.quux"}
will be interpreted as the pathname @file{#p"foo/bar.quux.lisp"}.
Finally, the @code{component-type} @code{:static-file}
wants a file without specifying a type, and so a string @code{"foo/bar"}
will be interpreted as the pathname @file{#p"foo/bar"},
and a string @code{"foo/bar.quux"}
will be interpreted as the pathname @file{#p"foo/bar.quux"}.

1152
1153
1154
1155
1156
1157
1158
1159
ASDF does not interpret the string @code{".."} to designate the parent
directory.  This string will be passed through to the underlying
operating system for interpretation.  We @emph{believe} that this will
work on all platforms where ASDF is deployed, but do not guarantee this
behavior.  A pathname object with a relative directory component of
@code{:up} or @code{:back} is the only guaranteed way to specify a
parent directory.

1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
If a symbol is given, it will be translated into a string,
and downcased in the process.
The downcasing of symbols is unconventional,
but was selected after some consideration.
Observations suggest that the type of systems we want to support
either have lowercase as customary case (Unix, Mac, windows)
or silently convert lowercase to uppercase (lpns),
so this makes more sense than attempting to use @code{:case :common}
as argument to @code{make-pathname},
which is reported not to work on some implementations.

1171
Pathname objects may be given to override the path for a component.
1172
1173
Such objects are typically specified using reader macros such as @code{#p}
or @code{#.(make-pathname ...)}.
1174
1175
Note however, that @code{#p...} is
a shorthand for @code{#.(parse-namestring ...)}
1176
and that the behavior of @code{parse-namestring} is completely non-portable,
1177
1178
unless you are using Common Lisp @code{logical-pathname}s,
which themselves involve other non-portable behavior
1179
(@pxref{The defsystem grammar,,Using logical pathnames}, below).
1180
1181
1182
1183
Pathnames made with @code{#.(make-pathname ...)}
can usually be done more easily with the string syntax above.
The only case that you really need a pathname object is to override
the component-type default file type for a given component.
1184
Therefore, pathname objects should only rarely be used.
1185
Unhappily, ASDF 1 didn't properly support
1186
1187
parsing component names as strings specifying paths with directories,
and the cumbersome @code{#.(make-pathname ...)} syntax had to be used.
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1188
1189
An alternative to @code{#.} read-time evaluation is to use
@code{(eval `(defsystem ... ,pathname ...))}.
1190

Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1191
Note that when specifying pathname objects,
1192
1193
1194
ASDF does not do any special interpretation of the pathname
influenced by the component type, unlike the procedure for
pathname-specifying strings.
1195
1196
1197
1198
1199
On the one hand, you have to be careful to provide a pathname that correctly
fulfills whatever constraints are required from that component type
(e.g. naming a directory or a file with appropriate type);
on the other hand, you can circumvent the file type that would otherwise
be forced upon you if you were specifying a string.
1200

1201
1202
1203
1204
@subsection Version specifiers
@cindex version specifiers
@cindex :version

1205
1206
1207
1208
1209
1210
1211
1212
Version specifiers are strings to be parsed as period-separated lists of integers.
I.e., in the example, @code{"0.2.1"} is to be interpreted,
roughly speaking, as @code{(0 2 1)}.
In particular, version @code{"0.2.1"} is interpreted the same as @code{"0.0002.1"},
though the latter is not canonical and may lead to a warning being issued.
Also, @code{"1.3"} and @code{"1.4"} are both strictly @code{uiop:version<} to @code{"1.30"},
quite unlike what would have happened
had the version strings been interpreted as decimal fractions.
1213
1214

System definers are encouraged to use version identifiers of the form
1215
1216
1217
@var{x}.@var{y}.@var{z} for
major version, minor version and patch level,
where significant API incompatibilities are signaled by an increased major number.
1218
1219
1220

@xref{Common attributes of components}.

1221

1222
@subsection Using logical pathnames
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
1223
@cindex logical pathnames
1224

1225
1226
1227
1228
We do not generally recommend the use of logical pathnames,
especially not so to newcomers to Common Lisp.
However, we do support the use of logical pathnames by old timers,
when such is their preference.
1229

1230
1231
1232