95 lines
9.9 KiB
HTML
95 lines
9.9 KiB
HTML
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>CLHS: Macro DO-SYMBOLS, DO-EXTERNAL-SYMBOLS...</TITLE>
|
|
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
|
|
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
|
|
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
|
|
<LINK REL=TOP HREF="../Front/index.htm">
|
|
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
|
|
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
|
|
<LINK REL=PREV HREF="m_defpkg.htm">
|
|
<LINK REL=UP HREF="c_packag.htm">
|
|
<LINK REL=NEXT HREF="f_intern.htm">
|
|
</HEAD>
|
|
<BODY>
|
|
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="m_defpkg.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_packag.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_intern.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="do-symbols"><A NAME="do-external-symbols"><A NAME="do-all-symbols"><I>Macro</I> <B>DO-SYMBOLS, DO-EXTERNAL-SYMBOLS, DO-ALL-SYMBOLS</B></A></A></A> <P>
|
|
<P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>do-symbols</B> <I>(var [package [result-form]]) <I>declaration</I><B>*</B> {tag | statement}*</I><P> => <I><I>result</I><B>*</B></I><P>
|
|
<P>
|
|
|
|
<B>do-external-symbols</B> <I>(var [package [result-form]]) <I>declaration</I><B>*</B> {tag | statement}*</I><P> => <I><I>result</I><B>*</B></I><P>
|
|
<P>
|
|
|
|
<B>do-all-symbols</B> <I>(var [result-form]) <I>declaration</I><B>*</B> {tag | statement}*</I><P> => <I><I>result</I><B>*</B></I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>var</I>---a <A REL=DEFINITION HREF="26_glo_v.htm#variable"><I>variable</I></A> <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A>; not evaluated. <P>
|
|
<I>package</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#package_designator"><I>package designator</I></A>; evaluated. The default in <A REL=DEFINITION HREF="#do-symbols"><B>do-symbols</B></A> and <A REL=DEFINITION HREF="#do-external-symbols"><B>do-external-symbols</B></A> is the <A REL=DEFINITION HREF="26_glo_c.htm#current_package"><I>current package</I></A>. <P>
|
|
<I>result-form</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#form"><I>form</I></A>; evaluated as described below. The default is <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
|
<I>declaration</I>---a <A REL=DEFINITION HREF="s_declar.htm#declare"><B>declare</B></A> <A REL=DEFINITION HREF="26_glo_e.htm#expression"><I>expression</I></A>; not evaluated. <P>
|
|
<I>tag</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#go_tag"><I>go tag</I></A>; not evaluated. <P>
|
|
<I>statement</I>---a <A REL=DEFINITION HREF="26_glo_c.htm#compound_form"><I>compound form</I></A>; evaluated as described below. <P>
|
|
<I>results</I>---the <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>values</I></A> returned by the <I>result-form</I> if a <A REL=DEFINITION HREF="26_glo_n.htm#normal_return"><I>normal return</I></A> occurs, or else, if an <A REL=DEFINITION HREF="26_glo_e.htm#explicit_return"><I>explicit return</I></A> occurs, the <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>values</I></A> that were transferred. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#do-symbols"><B>do-symbols</B></A>, <A REL=DEFINITION HREF="#do-external-symbols"><B>do-external-symbols</B></A>, and <A REL=DEFINITION HREF="#do-all-symbols"><B>do-all-symbols</B></A> iterate over the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> of <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A>. For each <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> in the set of <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A> chosen, the <I>var</I> is bound to the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>, and the <I>statements</I> in the body are executed. When all the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> have been processed, <I>result-form</I> is evaluated and returned as the value of the macro. <P>
|
|
<A REL=DEFINITION HREF="#do-symbols"><B>do-symbols</B></A> iterates over the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#accessible"><I>accessible</I></A> in <I>package</I>. <I>Statements</I> may execute more than once for <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> that are inherited from multiple <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A>. <P>
|
|
<A REL=DEFINITION HREF="#do-all-symbols"><B>do-all-symbols</B></A> iterates on every <A REL=DEFINITION HREF="26_glo_r.htm#registered_package"><I>registered package</I></A>. <A REL=DEFINITION HREF="#do-all-symbols"><B>do-all-symbols</B></A> will not process every <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> whatsoever, because a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> not <A REL=DEFINITION HREF="26_glo_a.htm#accessible"><I>accessible</I></A> in any <A REL=DEFINITION HREF="26_glo_r.htm#registered_package"><I>registered package</I></A> will not be processed. <A REL=DEFINITION HREF="#do-all-symbols"><B>do-all-symbols</B></A> may cause a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> that is <A REL=DEFINITION HREF="26_glo_p.htm#present"><I>present</I></A> in several <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A> to be processed more than once. <P>
|
|
<A REL=DEFINITION HREF="#do-external-symbols"><B>do-external-symbols</B></A> iterates on the external symbols of <I>package</I>. <P>
|
|
When <I>result-form</I> is evaluated, <I>var</I> is bound and has the value <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
|
An <A REL=DEFINITION HREF="26_glo_i.htm#implicit_block"><I>implicit block</I></A> named <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> surrounds the entire <A REL=DEFINITION HREF="#do-symbols"><B>do-symbols</B></A>, <A REL=DEFINITION HREF="#do-external-symbols"><B>do-external-symbols</B></A>, or <A REL=DEFINITION HREF="#do-all-symbols"><B>do-all-symbols</B></A> <A REL=DEFINITION HREF="26_glo_f.htm#form"><I>form</I></A>. <A REL=DEFINITION HREF="m_return.htm#return"><B>return</B></A> or <A REL=DEFINITION HREF="s_ret_fr.htm#return-from"><B>return-from</B></A> may be used to terminate the iteration prematurely. <P>
|
|
If execution of the body affects which <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> are contained in the set of <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>packages</I></A> over which iteration is occurring, other than to remove the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> currently the value of <I>var</I> by using <A REL=DEFINITION HREF="f_uninte.htm#unintern"><B>unintern</B></A>, the consequences are undefined. <P>
|
|
For each of these macros, the <A REL=DEFINITION HREF="26_glo_s.htm#scope"><I>scope</I></A> of the name binding does not include any initial value form, but the optional result forms are included. <P>
|
|
Any <I>tag</I> in the body is treated as with <A REL=DEFINITION HREF="s_tagbod.htm#tagbody"><B>tagbody</B></A>. <P>
|
|
<P><B>Examples:</B><P>
|
|
<P>
|
|
<PRE>
|
|
(make-package 'temp :use nil) => #<PACKAGE "TEMP">
|
|
(intern "SHY" 'temp) => TEMP::SHY, NIL ;SHY will be an internal symbol
|
|
;in the package TEMP
|
|
(export (intern "BOLD" 'temp) 'temp) => T ;BOLD will be external
|
|
(let ((lst ()))
|
|
(do-symbols (s (find-package 'temp)) (push s lst))
|
|
lst)
|
|
=> (TEMP::SHY TEMP:BOLD)
|
|
OR=> (TEMP:BOLD TEMP::SHY)
|
|
(let ((lst ()))
|
|
(do-external-symbols (s (find-package 'temp) lst) (push s lst))
|
|
lst)
|
|
=> (TEMP:BOLD)
|
|
(let ((lst ()))
|
|
(do-all-symbols (s lst)
|
|
(when (eq (find-package 'temp) (symbol-package s)) (push s lst)))
|
|
lst)
|
|
=> (TEMP::SHY TEMP:BOLD)
|
|
OR=> (TEMP:BOLD TEMP::SHY)
|
|
</PRE>
|
|
</TT> <P>
|
|
<P><B>Side Effects:</B> None.
|
|
<P>
|
|
<P><B>Affected By:</B> None.
|
|
<P>
|
|
<P><B>Exceptional Situations:</B> None.
|
|
<P>
|
|
<P><B>See Also:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="f_intern.htm#intern"><B>intern</B></A>, <A REL=DEFINITION HREF="f_export.htm#export"><B>export</B></A>, <A REL=CHILD HREF="03_f.htm">Section 3.6 (Traversal Rules and Side Effects)</A> <P>
|
|
<P><B>Notes:</B> None.
|
|
<P>
|
|
<P>
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss240.htm">MAPPING-DESTRUCTIVE-INTERACTION:EXPLICITLY-VAGUE</A><LI> <A REL=CHILD HREF="../Issues/iss133.htm">DO-SYMBOLS-BLOCK-SCOPE:ENTIRE-FORM</A><LI> <A REL=CHILD HREF="../Issues/iss134.htm">DO-SYMBOLS-DUPLICATES</A><LI> <A REL=CHILD HREF="../Issues/iss254.htm">PACKAGE-FUNCTION-CONSISTENCY:MORE-PERMISSIVE</A><LI> <A REL=CHILD HREF="../Issues/iss097.htm">DECLS-AND-DOC</A><P></UL><HR>
|
|
|
|
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
|
|
|
|
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
|
|
</BODY>
|
|
</HTML>
|