defsystem
is used to define systems for use with the LispWorks system tools. A system is a collection of files and other systems that, together with rules expressing the interdependencies of those files and subsystems, make a complete program. The LispWorks system tools support the development and maintenance of large programs. Find a full description at Common Defsystem and ASDF.
The name of the system to be made.
options are expressed as a list of keyword argument pairs. The following keywords are recognized:
The default package that files are compiled and loaded in. If not specified, this defaults to the value of
*package*
at macroexpansion time.
Used to compute a default pathname in which to find files.
defsystem
uses current-pathname to compute the pathname.
defsystem
checks that all the files given as members actually exist.
The root pathname of a system is defined to be the
:default-host
if it is given. Otherwise, it is taken to be the directory containing the defsystem file.
Absolute pathnames are interpreted literally, and relative pathnames are taken relative to the root pathname.
This is the default type of the members of the system. This may be
:lisp-file
,
:lsp-file
,
:c-file
, or
:system
.
The corba module adds
:idl-file
,
:idl-client-definition
,
:idl-client-definition-only
,
:idl-server-definition
and
:idl-server-definition-only
.
The com module adds the type
:midl-file
and the automation module adds
:midl-type-library-file
.
The default is
:lisp-file
, which means files with file type (extension) "lisp".
This is a string.
A string or pathname specifying a directory where object files are written.
Note: This option will not work if the names in members represent absolute pathnames.
A declaration specifying default compilation qualities within the scope of compile-system. These settings override the current global setting. They can be overridden per member by the
:optimize
option (for subsystems) or proclaim (in files). The
:optimize
defsystem
option accepts the same optimize qualities as proclaim and which are fully described in Compiler control. See below for examples.
members is a list defining the members of the system. Elements of the list may be a string name representing the name of the physical file or system referred to. Elements of the the list may also be a symbol, which is interpreted as its symbol name.
Elements of the
members
list can also be a list of the form
(
name
{
keyword
value
}*)
where
name
is once again a string or a symbol naming a file or system.
The members of
system-name
must have unique names, as compared by
equalp
. For example, if
members
contains
"foo"
then there cannot be another member (either a file or a system) named
"foo"
,
"FOO"
or
foo
.
The possible keywords and their values are:
The type of this member. Allowed values are as for
:default-type
. If not specified it defaults to the value of
:default-type
given as an
option
.
If
nil
then this member is not loaded unless its loading is specifically requested as a result of a dependency on another module
Only the source file for this member is ever loaded
The member is never compiled by
defsystem
, objects are loaded in preference to source files
The member is only loaded as necessary during compilation and is never loaded independently
The member is only considered during planning if the feature expression is true.
A default package for the member.
On Windows, the automation module adds the keyword
:com
for a member with type
:midl-type-library-file
. Then a member of the form
("mso97.tlb" :type :midl-type-library-file :com nil)
can be specified when you use only Automation client code, reducing the memory used.
rules is a list of rules of the following format :
({:in-order-to} action {:all | ({ member-name }* )}
(:caused-by {(action {:previous |{member-name }* }) }*)
(:requires {(action {:previous |{ member-name }*}) }*))
The keyword
:all
refers to all the members of the system. It provides a shorthand for specifying that a rule should apply to all the system's members. The keyword
:previous
refers to all the members of the system that are before the member in the list of members. This makes it easy, for example, to specify that in order to compile a file in a system, all the members that come before it must be loaded.
There are more details about the rules in DEFSYSTEM rules.
(defsystem defsys-macros
(:default-pathname "/usr/users/james/scm/defsys/"
:default-type :lisp-file
:package defsystem)
:members ("new-macros"
"scm-timemacros"))
(defsystem clos-sys
(:default-pathname "/usr/users/clc/defsys/"
:default-type :lsp-file
:package defsystem)
:members
(("defsys-macros" :type :system :root-module nil)
"class"
"time-methods"
("scm-pathname" :source-only t)
"execute-plan"
"file-types"
"make-system"
"conv-defsys")
:rules
((:in-order-to :compile ("class" "time-methods")
(:caused-by (:compile "defsys-macros"))
(:requires
(:load "defsys-macros")))
(:in-order-to :compile
("time-methods" "execute-plan")
(:requires (:load "class")))))
(defsystem dataworks-demo
(:default-type :system)
:members (
"db-class"
"planar"
"dataworks-dep"
"dataworks-interface-tk"
"dataworks-interface-tools"
"drugs-demo"
("gen-demo" :type :lisp-file)
("load-icon" :type :lisp-file :source-only t)
)
:rules ((:in-order-to :compile :all
(:requires (:load :previous)))))
This last example illustrates the use of
:optimize
.
(defsystem foo (:optimize ((speed 3) (space 3)
(safety 0)))
:members ("bar"
"baz")
:rules ((:compile :all
(:requires (:load :previous)))))
Systems that are members of another system must be declared in the system declaration file before the system of which they are a part.
The ordering of members is important and reflects the order in which operations are carried out on the members of the system.
LispWorks User Guide and Reference Manual - 21 Dec 2011