87 lines
7.1 KiB
HTML
87 lines
7.1 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 FIND-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_export.htm">
|
||
|
|
<LINK REL=UP HREF="c_packag.htm">
|
||
|
|
<LINK REL=NEXT HREF="f_find_p.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_export.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_find_p.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="find-symbol"><I>Function</I> <B>FIND-SYMBOL</B></A> <P>
|
||
|
|
<P><B>Syntax:</B><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>find-symbol</B> <I>string <TT>&optional</TT> package</I> => <I>symbol, status</I><P>
|
||
|
|
<P>
|
||
|
|
<P><B>Arguments and Values:</B><P>
|
||
|
|
<P>
|
||
|
|
<I>string</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A>. <P>
|
||
|
|
<I>package</I>---a <A REL=DEFINITION HREF="26_glo_p.htm#package_designator"><I>package designator</I></A>. The default is the <A REL=DEFINITION HREF="26_glo_c.htm#current_package"><I>current package</I></A>. <P>
|
||
|
|
<I>symbol</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> accessible in the <I>package</I>, or <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
<I>status</I>---one of <TT>:inherited</TT>, <TT>:external</TT>, <TT>:internal</TT>, or <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
<P><B>Description:</B><P>
|
||
|
|
<P>
|
||
|
|
<A REL=DEFINITION HREF="#find-symbol"><B>find-symbol</B></A> locates a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is <I>string</I> in a <A REL=DEFINITION HREF="26_glo_p.htm#package"><I>package</I></A>. If a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> named <I>string</I> is found in <I>package</I>, directly or by inheritance, the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> found is returned as the first value; the second value is as follows: <P>
|
||
|
|
<P><DL><DT><TT>:internal</TT> <P><DD>
|
||
|
|
If the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is <A REL=DEFINITION HREF="26_glo_p.htm#present"><I>present</I></A> in <I>package</I> as an <A REL=DEFINITION HREF="26_glo_i.htm#internal_symbol"><I>internal symbol</I></A>. <P>
|
||
|
|
<DT><TT>:external</TT> <P><DD>
|
||
|
|
If the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is <A REL=DEFINITION HREF="26_glo_p.htm#present"><I>present</I></A> in <I>package</I> as an <A REL=DEFINITION HREF="26_glo_e.htm#external_symbol"><I>external symbol</I></A>. <P>
|
||
|
|
<DT><TT>:inherited</TT> <P><DD>
|
||
|
|
If the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is inherited by <I>package</I> through <A REL=DEFINITION HREF="f_use_pk.htm#use-package"><B>use-package</B></A>, but is not <A REL=DEFINITION HREF="26_glo_p.htm#present"><I>present</I></A> in <I>package</I>. <P>
|
||
|
|
<P></DL><P>
|
||
|
|
If no such <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> is <A REL=DEFINITION HREF="26_glo_a.htm#accessible"><I>accessible</I></A> in <I>package</I>, both values are <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
<P><B>Examples:</B><P>
|
||
|
|
<P>
|
||
|
|
<PRE>
|
||
|
|
(find-symbol "NEVER-BEFORE-USED") => NIL, NIL
|
||
|
|
(find-symbol "NEVER-BEFORE-USED") => NIL, NIL
|
||
|
|
(intern "NEVER-BEFORE-USED") => NEVER-BEFORE-USED, NIL
|
||
|
|
(intern "NEVER-BEFORE-USED") => NEVER-BEFORE-USED, :INTERNAL
|
||
|
|
(find-symbol "NEVER-BEFORE-USED") => NEVER-BEFORE-USED, :INTERNAL
|
||
|
|
(find-symbol "never-before-used") => NIL, NIL
|
||
|
|
(find-symbol "CAR" 'common-lisp-user) => CAR, :INHERITED
|
||
|
|
(find-symbol "CAR" 'common-lisp) => CAR, :EXTERNAL
|
||
|
|
(find-symbol "NIL" 'common-lisp-user) => NIL, :INHERITED
|
||
|
|
(find-symbol "NIL" 'common-lisp) => NIL, :EXTERNAL
|
||
|
|
(find-symbol "NIL" (prog1 (make-package "JUST-TESTING" :use '())
|
||
|
|
(intern "NIL" "JUST-TESTING")))
|
||
|
|
=> JUST-TESTING::NIL, :INTERNAL
|
||
|
|
(export 'just-testing::nil 'just-testing)
|
||
|
|
(find-symbol "NIL" 'just-testing) => JUST-TESTING:NIL, :EXTERNAL
|
||
|
|
(find-symbol "NIL" "KEYWORD")
|
||
|
|
=> NIL, NIL
|
||
|
|
OR=> :NIL, :EXTERNAL
|
||
|
|
(find-symbol (symbol-name :nil) "KEYWORD") => :NIL, :EXTERNAL
|
||
|
|
</PRE>
|
||
|
|
</TT> <P>
|
||
|
|
<P><B>Side Effects:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Affected By:</B><P>
|
||
|
|
<P>
|
||
|
|
<A REL=DEFINITION HREF="f_intern.htm#intern"><B>intern</B></A>, <A REL=DEFINITION HREF="f_import.htm#import"><B>import</B></A>, <A REL=DEFINITION HREF="f_export.htm#export"><B>export</B></A>, <A REL=DEFINITION HREF="f_use_pk.htm#use-package"><B>use-package</B></A>, <A REL=DEFINITION HREF="f_uninte.htm#unintern"><B>unintern</B></A>, <A REL=DEFINITION HREF="f_unexpo.htm#unexport"><B>unexport</B></A>, <A REL=DEFINITION HREF="f_unuse_.htm#unuse-package"><B>unuse-package</B></A> <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_find_a.htm#find-all-symbols"><B>find-all-symbols</B></A> <P>
|
||
|
|
<P><B>Notes:</B><P>
|
||
|
|
<P>
|
||
|
|
<A REL=DEFINITION HREF="#find-symbol"><B>find-symbol</B></A> is operationally equivalent to <A REL=DEFINITION HREF="f_intern.htm#intern"><B>intern</B></A>, except that it never creates a new <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
|
||
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issue</A>, <I>not part of the specification</I>, applies to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss254.htm">PACKAGE-FUNCTION-CONSISTENCY:MORE-PERMISSIVE</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>
|