160 lines
7.4 KiB
HTML
160 lines
7.4 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
|
<html>
|
||
|
|
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<!-- This manual describes ASDF, a system definition facility
|
||
|
|
for Common Lisp programs and libraries.
|
||
|
|
|
||
|
|
You can find the latest version of this manual at
|
||
|
|
https://common-lisp.net/project/asdf/asdf.html.
|
||
|
|
|
||
|
|
ASDF Copyright (C) 2001-2019 Daniel Barlow and contributors.
|
||
|
|
|
||
|
|
This manual Copyright (C) 2001-2019 Daniel Barlow and contributors.
|
||
|
|
|
||
|
|
This manual revised (C) 2009-2019 Robert P. Goldman and Francois-Rene Rideau.
|
||
|
|
|
||
|
|
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.
|
||
|
|
-->
|
||
|
|
<title>Pre-defined subclasses of component (ASDF Manual)</title>
|
||
|
|
|
||
|
|
<meta name="description" content="Pre-defined subclasses of component (ASDF Manual)">
|
||
|
|
<meta name="keywords" content="Pre-defined subclasses of component (ASDF Manual)">
|
||
|
|
<meta name="resource-type" content="document">
|
||
|
|
<meta name="distribution" content="global">
|
||
|
|
<meta name="Generator" content="makeinfo">
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
|
|
||
|
|
<link href="index.html" rel="start" title="Top">
|
||
|
|
<link href="Concept-Index.html" rel="index" title="Concept Index">
|
||
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||
|
|
<link href="Components.html" rel="up" title="Components">
|
||
|
|
<link href="Creating-new-component-types.html" rel="next" title="Creating new component types">
|
||
|
|
<link href="Common-attributes-of-components.html" rel="prev" title="Common attributes of components">
|
||
|
|
<style type="text/css">
|
||
|
|
<!--
|
||
|
|
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
|
||
|
|
a.summary-letter {text-decoration: none}
|
||
|
|
blockquote.indentedblock {margin-right: 0em}
|
||
|
|
div.display {margin-left: 3.2em}
|
||
|
|
div.example {margin-left: 3.2em}
|
||
|
|
kbd {font-style: oblique}
|
||
|
|
pre.display {font-family: inherit}
|
||
|
|
pre.format {font-family: inherit}
|
||
|
|
pre.menu-comment {font-family: serif}
|
||
|
|
pre.menu-preformatted {font-family: serif}
|
||
|
|
span.nolinebreak {white-space: nowrap}
|
||
|
|
span.roman {font-family: initial; font-weight: normal}
|
||
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
||
|
|
span:hover a.copiable-anchor {visibility: visible}
|
||
|
|
ul.no-bullet {list-style: none}
|
||
|
|
-->
|
||
|
|
</style>
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body lang="en">
|
||
|
|
<div class="subsection" id="Pre_002ddefined-subclasses-of-component">
|
||
|
|
<div class="header">
|
||
|
|
<p>
|
||
|
|
Next: <a href="Creating-new-component-types.html" accesskey="n" rel="next">Creating new component types</a>, Previous: <a href="Common-attributes-of-components.html" accesskey="p" rel="prev">Common attributes of components</a>, Up: <a href="Components.html" accesskey="u" rel="up">Components</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
<span id="Pre_002ddefined-subclasses-of-component-1"></span><h4 class="subsection">7.2.2 Pre-defined subclasses of component</h4>
|
||
|
|
|
||
|
|
<dl class="def">
|
||
|
|
<dt id="index-source_002dfile"><span class="category">Component: </span><span><strong>source-file</strong><a href='Pre_002ddefined-subclasses-of-component.html#index-source_002dfile' class='copiable-anchor'> ¶</a></span></dt>
|
||
|
|
<dd>
|
||
|
|
<p>A source file is any file that the system does not know how to
|
||
|
|
generate from other components of the system.
|
||
|
|
</p>
|
||
|
|
<p>Note that this is not necessarily the same thing as
|
||
|
|
“a file containing data that is typically fed to a compiler”.
|
||
|
|
If a file is generated by some pre-processor stage
|
||
|
|
(e.g. a <samp>.h</samp> file from <samp>.h.in</samp> by autoconf)
|
||
|
|
then it is not, by this definition, a source file.
|
||
|
|
Conversely, we might have a graphic file
|
||
|
|
that cannot be automatically regenerated,
|
||
|
|
or a proprietary shared library that we received as a binary:
|
||
|
|
these do count as source files for our purposes.
|
||
|
|
</p>
|
||
|
|
<p>Subclasses of source-file exist for various languages.
|
||
|
|
<em>FIXME: describe these.</em>
|
||
|
|
</p></dd></dl>
|
||
|
|
|
||
|
|
<dl class="def">
|
||
|
|
<dt id="index-module"><span class="category">Component: </span><span><strong>module</strong><a href='Pre_002ddefined-subclasses-of-component.html#index-module' class='copiable-anchor'> ¶</a></span></dt>
|
||
|
|
<dd>
|
||
|
|
<p>A module is a collection of sub-components.
|
||
|
|
</p>
|
||
|
|
<p>A module component has the following extra initargs:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li> <code>:components</code> the components contained in this module
|
||
|
|
|
||
|
|
</li><li> <code>:default-component-class</code>
|
||
|
|
All children components which don’t specify their class explicitly
|
||
|
|
are inferred to be of this type.
|
||
|
|
|
||
|
|
</li><li> <code>:if-component-dep-fails</code>
|
||
|
|
This attribute was removed in ASDF 3. Do not use it.
|
||
|
|
Use <code>:if-feature</code> instead (see <a href="Common-attributes-of-components.html#required_002dfeatures">required-features</a>, and see <a href="The-defsystem-grammar.html#if_002dfeature-option">if-feature option</a>).
|
||
|
|
|
||
|
|
</li><li> <code>:serial</code> When this attribute is set,
|
||
|
|
each subcomponent of this component is assumed to depend on all subcomponents
|
||
|
|
before it in the list given to <code>:components</code>, i.e.
|
||
|
|
all of them are loaded before a compile or load operation is performed on it.
|
||
|
|
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<p>The default operation knows how to traverse a module, so
|
||
|
|
most operations will not need to provide methods specialised on modules.
|
||
|
|
</p>
|
||
|
|
<p><code>module</code> may be subclassed to represent components such as
|
||
|
|
foreign-language linked libraries or archive files.
|
||
|
|
</p></dd></dl>
|
||
|
|
|
||
|
|
<dl class="def">
|
||
|
|
<dt id="index-system-1"><span class="category">Component: </span><span><strong>system</strong><a href='Pre_002ddefined-subclasses-of-component.html#index-system-1' class='copiable-anchor'> ¶</a></span></dt>
|
||
|
|
<dd>
|
||
|
|
<p><code>system</code> is a subclass of <code>module</code>.
|
||
|
|
</p>
|
||
|
|
<p>A system is a module with a few extra attributes for documentation
|
||
|
|
purposes; these are given elsewhere.
|
||
|
|
See <a href="The-defsystem-grammar.html">The defsystem grammar</a>.
|
||
|
|
</p>
|
||
|
|
<p>Users can create new classes for their systems:
|
||
|
|
the default <code>defsystem</code> macro takes a <code>:class</code> keyword argument.
|
||
|
|
</p></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<hr>
|
||
|
|
<div class="header">
|
||
|
|
<p>
|
||
|
|
Next: <a href="Creating-new-component-types.html">Creating new component types</a>, Previous: <a href="Common-attributes-of-components.html">Common attributes of components</a>, Up: <a href="Components.html">Components</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|