81 lines
7.4 KiB
HTML
81 lines
7.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: Function COPY-SYMBOL</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="f_mk_sym.htm">
|
|
<LINK REL=UP HREF="c_symbol.htm">
|
|
<LINK REL=NEXT HREF="f_gensym.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="f_mk_sym.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_symbol.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_gensym.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="copy-symbol"><I>Function</I> <B>COPY-SYMBOL</B></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>copy-symbol</B> <I>symbol <TT>&optional</TT> copy-properties</I> => <I>new-symbol</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>symbol</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
|
|
<I>copy-properties</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. The default is <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. <P>
|
|
<I>new-symbol</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#fresh"><I>fresh</I></A>, <A REL=DEFINITION HREF="26_glo_u.htm#uninterned"><I>uninterned</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#copy-symbol"><B>copy-symbol</B></A> returns a <A REL=DEFINITION HREF="26_glo_f.htm#fresh"><I>fresh</I></A>, <A REL=DEFINITION HREF="26_glo_u.htm#uninterned"><I>uninterned</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>, the <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> of which is <A REL=DEFINITION HREF="f_stgeq_.htm#stringEQ"><B>string=</B></A> to and possibly the <A REL=DEFINITION HREF="26_glo_s.htm#same"><I>same</I></A> as the <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> of the given <I>symbol</I>. <P>
|
|
If <I>copy-properties</I> is <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>, the <I>new-symbol</I> is neither <A REL=DEFINITION HREF="26_glo_b.htm#bound"><I>bound</I></A> nor <A REL=DEFINITION HREF="26_glo_f.htm#fbound"><I>fbound</I></A> and has a <A REL=DEFINITION HREF="26_glo_n.htm#null"><I>null</I></A> <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A>. If <I>copy-properties</I> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>, then the initial <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A> of <I>new-symbol</I> is the <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A> of <I>symbol</I>, the initial <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> definition of <I>new-symbol</I> is the <A REL=DEFINITION HREF="26_glo_f.htm#functional_value"><I>functional value</I></A> of <I>symbol</I>, and the <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A> of <I>new-symbol</I> is a <A REL=DEFINITION HREF="26_glo_c.htm#copy"><I>copy</I></A>[2] of the <A REL=DEFINITION HREF="26_glo_p.htm#property_list"><I>property list</I></A> of <I>symbol</I>. <P>
|
|
<P><B>Examples:</B><P>
|
|
<P>
|
|
<PRE>
|
|
(setq fred 'fred-smith) => FRED-SMITH
|
|
(setf (symbol-value fred) 3) => 3
|
|
(setq fred-clone-1a (copy-symbol fred nil)) => #:FRED-SMITH
|
|
(setq fred-clone-1b (copy-symbol fred nil)) => #:FRED-SMITH
|
|
(setq fred-clone-2a (copy-symbol fred t)) => #:FRED-SMITH
|
|
(setq fred-clone-2b (copy-symbol fred t)) => #:FRED-SMITH
|
|
(eq fred fred-clone-1a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(eq fred-clone-1a fred-clone-1b) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(eq fred-clone-2a fred-clone-2b) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(eq fred-clone-1a fred-clone-2a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(symbol-value fred) => 3
|
|
(boundp fred-clone-1a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(symbol-value fred-clone-2a) => 3
|
|
(setf (symbol-value fred-clone-2a) 4) => 4
|
|
(symbol-value fred) => 3
|
|
(symbol-value fred-clone-2a) => 4
|
|
(symbol-value fred-clone-2b) => 3
|
|
(boundp fred-clone-1a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(setf (symbol-function fred) #'(lambda (x) x)) => #<FUNCTION anonymous>
|
|
(fboundp fred) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
(fboundp fred-clone-1a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(fboundp fred-clone-2a) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
</PRE>
|
|
</TT> <P>
|
|
<P><B>Side Effects:</B> None.
|
|
<P>
|
|
<P><B>Affected By:</B> None.
|
|
<P>
|
|
<P><B>Exceptional Situations:</B><P>
|
|
<P>
|
|
Should signal an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_tp_err.htm#type-error"><B>type-error</B></A> if <I>symbol</I> is not a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
|
|
<P><B>See Also:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="f_mk_sym.htm#make-symbol"><B>make-symbol</B></A> <P>
|
|
<P><B>Notes:</B><P>
|
|
<P>
|
|
Implementors are encouraged not to copy the <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A> which is the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>'s <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> unnecessarily. Unless there is a good reason to do so, the normal implementation strategy is for the <I>new-symbol</I>'s <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> to be <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> to the given <I>symbol</I>'s <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A>. <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/iss087.htm">COPY-SYMBOL-COPY-PLIST:COPY-LIST</A><LI> <A REL=CHILD HREF="../Issues/iss088.htm">COPY-SYMBOL-PRINT-NAME:EQUAL</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>
|