78 lines
5.4 KiB
HTML
78 lines
5.4 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 MULTIPLE-VALUE-SETQ</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="s_mult_1.htm">
|
||
|
<LINK REL=UP HREF="c_data_a.htm">
|
||
|
<LINK REL=NEXT HREF="f_values.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="s_mult_1.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_data_a.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_values.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
||
|
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="multiple-value-setq"><I>Macro</I> <B>MULTIPLE-VALUE-SETQ</B></A> <P>
|
||
|
<P><B>Syntax:</B><P>
|
||
|
<P>
|
||
|
|
||
|
<B>multiple-value-setq</B> <I>vars form</I> => <I>result</I><P>
|
||
|
<P>
|
||
|
<P><B>Arguments and Values:</B><P>
|
||
|
<P>
|
||
|
<I>vars</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A> of <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> that are either <A REL=DEFINITION HREF="26_glo_v.htm#variable"><I>variable</I></A> <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>names</I></A> or <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>names</I></A> of <A REL=DEFINITION HREF="26_glo_s.htm#symbol_macro"><I>symbol macros</I></A>. <P>
|
||
|
<I>form</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#form"><I>form</I></A>. <P>
|
||
|
<I>result</I>---The <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A> returned by the <I>form</I>. <P>
|
||
|
<P><B>Description:</B><P>
|
||
|
<P>
|
||
|
<A REL=DEFINITION HREF="#multiple-value-setq"><B>multiple-value-setq</B></A> assigns values to <I>vars</I>. <P>
|
||
|
The <I>form</I> is evaluated, and each <I>var</I> is <I>assigned</I> to the corresponding <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A> returned by that <A REL=DEFINITION HREF="26_glo_f.htm#form"><I>form</I></A>. If there are more <I>vars</I> than <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>values</I></A> returned, <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> is <I>assigned</I> to the extra <I>vars</I>. If there are more <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>values</I></A> than <I>vars</I>, the extra <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>values</I></A> are discarded. <P>
|
||
|
If any <I>var</I> is the <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> of a <A REL=DEFINITION HREF="26_glo_s.htm#symbol_macro"><I>symbol macro</I></A>, then it is <I>assigned</I> as if by <A REL=DEFINITION HREF="m_setf_.htm#setf"><B>setf</B></A>. Specifically, <P>
|
||
|
|
||
|
<PRE>
|
||
|
(multiple-value-setq (symbol</TT>1<TT> ... symbol</TT>n<TT>) value-producing-form)
|
||
|
</PRE>
|
||
|
</TT> is defined to always behave in the same way as <P>
|
||
|
<PRE>
|
||
|
(values (setf (values symbol</TT>1<TT> ... symbol</TT>n<TT>) value-producing-form))
|
||
|
</PRE>
|
||
|
</TT> in order that the rules for order of evaluation and side-effects be consistent with those used by <A REL=DEFINITION HREF="m_setf_.htm#setf"><B>setf</B></A>. See <A REL=CHILD HREF="05_abc.htm">Section 5.1.2.3 (VALUES Forms as Places)</A>. <P>
|
||
|
<P><B>Examples:</B><P>
|
||
|
<P>
|
||
|
<PRE>
|
||
|
(multiple-value-setq (quotient remainder) (truncate 3.2 2)) => 1
|
||
|
quotient => 1
|
||
|
remainder => 1.2
|
||
|
(multiple-value-setq (a b c) (values 1 2)) => 1
|
||
|
a => 1
|
||
|
b => 2
|
||
|
c => NIL
|
||
|
(multiple-value-setq (a b) (values 4 5 6)) => 4
|
||
|
a => 4
|
||
|
b => 5
|
||
|
</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="s_setq.htm#setq"><B>setq</B></A>, <A REL=DEFINITION HREF="s_symbol.htm#symbol-macrolet"><B>symbol-macrolet</B></A> <P>
|
||
|
<P><B>Notes:</B> None.
|
||
|
<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/iss245.htm">MULTIPLE-VALUE-SETQ-ORDER:LIKE-SETF-OF-VALUES</A><LI> <A REL=CHILD HREF="../Issues/iss338.htm">SYMBOL-MACROLET-SEMANTICS:SPECIAL-FORM</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>
|