402 lines
No EOL
8.1 KiB
HTML
402 lines
No EOL
8.1 KiB
HTML
<!DOCTYPE HTML>
|
|
<HTML LANG="en-us"
|
|
><HEAD
|
|
><TITLE
|
|
>use-package | Common Lisp Nova Spec</TITLE
|
|
><META CHARSET="US-ASCII"
|
|
><LINK REL="canonical" HREF="f_use-package.html"
|
|
><LINK REL="next" HREF="f_defpackage.html" TYPE="text/html" TITLE="defpackage"
|
|
><LINK REL="prev" HREF="f_unuse-package.html" TYPE="text/html" TITLE="unuse-package"
|
|
><LINK REL="up" HREF="11_2_Packages_Dictionary.html" TYPE="text/html" TITLE="11.2 Packages Dictionary"
|
|
><LINK REL="start" HREF="index.html" TYPE="text/html" TITLE="Common Lisp Nova Spec"
|
|
><META NAME="VIEWPORT" CONTENT="width=device-width, initial-scale=1.0"
|
|
><LINK REL="STYLESHEET" HREF="dpans.css%3F3909942064.css"
|
|
><SCRIPT SRC="dpans.js%3F3909942064"
|
|
></SCRIPT
|
|
><SCRIPT SRC="apropos.js%3F3909942064"
|
|
></SCRIPT
|
|
></HEAD
|
|
><BODY
|
|
><DIV
|
|
><DIV CLASS="topnav"
|
|
><DIV CLASS="breadcrumb"
|
|
><SPAN CLASS="breadcrumb-item"
|
|
><A HREF="index.html"
|
|
>Common Lisp Nova Spec</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="11_Packages.html"
|
|
>11. Packages</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="11_2_Packages_Dictionary.html"
|
|
>11.2 Packages Dictionary</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="f_use-package.html"
|
|
>use-package</A
|
|
></SPAN
|
|
></DIV
|
|
><DIV CLASS="apropos"
|
|
><DIV CLASS="apropos-io"
|
|
><A HREF="f_unuse-package.html" CLASS="prev"
|
|
>←</A
|
|
><SPAN ID="apropos-label"
|
|
>Apropos </SPAN
|
|
><INPUT ID="apropos" AUTOFOCUS="AUTOFOCUS" PLACEHOLDER="Type here to search" ONINPUT="aproposInput(this);" ONKEYUP="aproposKeyup(event);" ONCHANGE="aproposChange(this);" ONFOCUS="aproposFocus(this);" ONFOCUSOUT="aproposFocusout(this);"
|
|
><A HREF="f_defpackage.html" CLASS="next"
|
|
>→</A
|
|
></DIV
|
|
><DIV ID="apropos-res"
|
|
></DIV
|
|
></DIV
|
|
></DIV
|
|
><DIV CLASS="matter"
|
|
><DIV CLASS="com"
|
|
><DIV CLASS="begincom"
|
|
><HR
|
|
><TABLE WIDTH="100%" CELLSPACING="0" CELLPADDING="0"
|
|
><TR
|
|
><TD ALIGN="LEFT" VALIGN="BASELINE" WIDTH="100%" CLASS="name"
|
|
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="use-package"
|
|
></SPAN
|
|
><B
|
|
>use-package</B
|
|
></TD
|
|
><TD ALIGN="RIGHT" VALIGN="BASELINE" WIDTH="0" NOWRAP="NOWRAP" CLASS="ftype"
|
|
><I
|
|
>Function</I
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
></DIV
|
|
><UL CLASS="subtoc"
|
|
></UL
|
|
><DL
|
|
><DT
|
|
><B
|
|
>Syntax</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><B
|
|
>use-package</B
|
|
> <SPAN CLASS="cmssi"
|
|
>packages-to-use</SPAN
|
|
> <SPAN CLASS="cmtt"
|
|
>&optional</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>package</SPAN
|
|
> <SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
> <SPAN CLASS="misc"
|
|
><B
|
|
>t</B
|
|
></SPAN
|
|
></P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Arguments and Values</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>packages-to-use</VAR
|
|
> — a <A HREF="26_1_Glossary.html#designator"
|
|
><EM CLASS="term"
|
|
>designator</EM
|
|
></A
|
|
> for a <A HREF="26_1_Glossary.html#list"
|
|
><EM CLASS="term"
|
|
>list</EM
|
|
></A
|
|
> of <A HREF="26_1_Glossary.html#package_designator"
|
|
><EM CLASS="term"
|
|
>package designators</EM
|
|
></A
|
|
>. The <SPAN CLASS="packref"
|
|
><SPAN CLASS="cmtt"
|
|
>KEYWORD</SPAN
|
|
></SPAN
|
|
> <A HREF="26_1_Glossary.html#package"
|
|
><EM CLASS="term"
|
|
>package</EM
|
|
></A
|
|
> may not be supplied. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>package</VAR
|
|
> — a <A HREF="26_1_Glossary.html#package_designator"
|
|
><EM CLASS="term"
|
|
>package designator</EM
|
|
></A
|
|
>. The default is the <A HREF="26_1_Glossary.html#current_package"
|
|
><EM CLASS="term"
|
|
>current package</EM
|
|
></A
|
|
>. The <VAR CLASS="param"
|
|
>package</VAR
|
|
> cannot be the <SPAN CLASS="packref"
|
|
><SPAN CLASS="cmtt"
|
|
>KEYWORD</SPAN
|
|
></SPAN
|
|
> <A HREF="26_1_Glossary.html#package"
|
|
><EM CLASS="term"
|
|
>package</EM
|
|
></A
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Description</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><A HREF="f_use-package.html" CLASS="funref"
|
|
><B
|
|
>use-package</B
|
|
></A
|
|
> causes <VAR CLASS="param"
|
|
>package</VAR
|
|
> to inherit all the <A HREF="26_1_Glossary.html#external_symbol"
|
|
><EM CLASS="term"
|
|
>external symbols</EM
|
|
></A
|
|
> of <VAR CLASS="param"
|
|
>packages-to-use</VAR
|
|
>. The inherited <A HREF="26_1_Glossary.html#symbol"
|
|
><EM CLASS="term"
|
|
>symbols</EM
|
|
></A
|
|
> become <A HREF="26_1_Glossary.html#accessible"
|
|
><EM CLASS="term"
|
|
>accessible</EM
|
|
></A
|
|
> as <A HREF="26_1_Glossary.html#internal_symbol"
|
|
><EM CLASS="term"
|
|
>internal symbols</EM
|
|
></A
|
|
> of <VAR CLASS="param"
|
|
>package</VAR
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>Packages-to-use</VAR
|
|
> are added to the <A HREF="26_1_Glossary.html#use_list"
|
|
><EM CLASS="term"
|
|
>use list</EM
|
|
></A
|
|
> of <VAR CLASS="param"
|
|
>package</VAR
|
|
> if they are not there already. All <A HREF="26_1_Glossary.html#external_symbol"
|
|
><EM CLASS="term"
|
|
>external symbols</EM
|
|
></A
|
|
> in <VAR CLASS="param"
|
|
>packages-to-use</VAR
|
|
> become <A HREF="26_1_Glossary.html#accessible"
|
|
><EM CLASS="term"
|
|
>accessible</EM
|
|
></A
|
|
> in <VAR CLASS="param"
|
|
>package</VAR
|
|
> as <A HREF="26_1_Glossary.html#internal_symbol"
|
|
><EM CLASS="term"
|
|
>internal symbols</EM
|
|
></A
|
|
>. <A HREF="f_use-package.html" CLASS="funref"
|
|
><B
|
|
>use-package</B
|
|
></A
|
|
> does not cause any new <A HREF="26_1_Glossary.html#symbol"
|
|
><EM CLASS="term"
|
|
>symbols</EM
|
|
></A
|
|
> to be <A HREF="26_1_Glossary.html#present"
|
|
><EM CLASS="term"
|
|
>present</EM
|
|
></A
|
|
> in <VAR CLASS="param"
|
|
>package</VAR
|
|
> but only makes them <A HREF="26_1_Glossary.html#accessible"
|
|
><EM CLASS="term"
|
|
>accessible</EM
|
|
></A
|
|
> by inheritance. </P
|
|
><P CLASS="j"
|
|
><A HREF="f_use-package.html" CLASS="funref"
|
|
><B
|
|
>use-package</B
|
|
></A
|
|
> checks for name conflicts between the newly imported symbols and those already <A HREF="26_1_Glossary.html#accessible"
|
|
><EM CLASS="term"
|
|
>accessible</EM
|
|
></A
|
|
> in <VAR CLASS="param"
|
|
>package</VAR
|
|
>. A name conflict in <A HREF="f_use-package.html" CLASS="funref"
|
|
><B
|
|
>use-package</B
|
|
></A
|
|
> between two external symbols inherited by <VAR CLASS="param"
|
|
>package</VAR
|
|
> from <VAR CLASS="param"
|
|
>packages-to-use</VAR
|
|
> may be resolved in favor of either <A HREF="26_1_Glossary.html#symbol"
|
|
><EM CLASS="term"
|
|
>symbol</EM
|
|
></A
|
|
> by <A HREF="26_1_Glossary.html#import"
|
|
><EM CLASS="term"
|
|
>importing</EM
|
|
></A
|
|
> one of them into <VAR CLASS="param"
|
|
>package</VAR
|
|
> and making it a shadowing symbol.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Examples</B
|
|
></DT
|
|
><DD
|
|
><PRE CLASS="screen"
|
|
>(export (intern "LAND-FILL" (make-package 'trash)) 'trash) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> T
|
|
(find-symbol "LAND-FILL" (make-package 'temp)) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> NIL, NIL
|
|
(package-use-list 'temp) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> (#<PACKAGE "TEMP">)
|
|
(use-package 'trash 'temp) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> T
|
|
(package-use-list 'temp) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> (#<PACKAGE "TEMP"> #<PACKAGE "TRASH">)
|
|
(find-symbol "LAND-FILL" 'temp) <SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> TRASH:LAND-FILL, :INHERITED</PRE
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Side Effects</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
>The <A HREF="26_1_Glossary.html#use_list"
|
|
><EM CLASS="term"
|
|
>use list</EM
|
|
></A
|
|
> of <VAR CLASS="param"
|
|
>package</VAR
|
|
> may be modified.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>See Also</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><A HREF="f_unuse-package.html" CLASS="funref"
|
|
><B
|
|
>unuse-package</B
|
|
></A
|
|
>, <A HREF="f_package-use-list.html" CLASS="funref"
|
|
><B
|
|
>package-use-list</B
|
|
></A
|
|
>, <A HREF="11_1_Package_Concepts.html#sec_11_1" CLASS="secref"
|
|
><SPAN CLASS="cmr"
|
|
>Section</SPAN
|
|
> <SPAN CLASS="cmr"
|
|
>11.1</SPAN
|
|
> <SPAN CLASS="cmr"
|
|
>(Package</SPAN
|
|
> <SPAN CLASS="cmr"
|
|
>Concepts)</SPAN
|
|
></A
|
|
></P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Notes</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
>It is permissible for a <A HREF="26_1_Glossary.html#package"
|
|
><EM CLASS="term"
|
|
>package</EM
|
|
></A
|
|
> <I
|
|
>P</I
|
|
><SUB CLASS="sub"
|
|
><SPAN CLASS="cmr"
|
|
>1</SPAN
|
|
></SUB
|
|
> to <A HREF="26_1_Glossary.html#use"
|
|
><EM CLASS="term"
|
|
>use</EM
|
|
></A
|
|
> a <A HREF="26_1_Glossary.html#package"
|
|
><EM CLASS="term"
|
|
>package</EM
|
|
></A
|
|
> <I
|
|
>P</I
|
|
><SUB CLASS="sub"
|
|
><SPAN CLASS="cmr"
|
|
>2</SPAN
|
|
></SUB
|
|
> even if <I
|
|
>P</I
|
|
><SUB CLASS="sub"
|
|
><SPAN CLASS="cmr"
|
|
>2</SPAN
|
|
></SUB
|
|
> already uses <I
|
|
>P</I
|
|
><SUB CLASS="sub"
|
|
><SPAN CLASS="cmr"
|
|
>1</SPAN
|
|
></SUB
|
|
>. The using of <A HREF="26_1_Glossary.html#package"
|
|
><EM CLASS="term"
|
|
>packages</EM
|
|
></A
|
|
> is not transitive, so no problem results from the apparent circularity.</P
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
></DIV
|
|
><DIV CLASS="footer"
|
|
><DIV CLASS="btmnav"
|
|
><A HREF="f_unuse-package.html" CLASS="prev"
|
|
>←</A
|
|
><A HREF="f_defpackage.html" CLASS="next"
|
|
>→</A
|
|
></DIV
|
|
><DIV CLASS="trail"
|
|
>Conversion to HTML copyright 2023 by Gilbert Baumann</DIV
|
|
></DIV
|
|
></DIV
|
|
><SCRIPT
|
|
>domReady();</SCRIPT
|
|
></BODY
|
|
></HTML
|
|
> |