67 lines
5.3 KiB
HTML
67 lines
5.3 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 PRINT-UNREADABLE-OBJECT</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_pr_obj.htm">
|
||
|
|
<LINK REL=UP HREF="c_printe.htm">
|
||
|
|
<LINK REL=NEXT HREF="f_set_pp.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_pr_obj.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_printe.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_set_pp.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="print-unreadable-object"><I>Macro</I> <B>PRINT-UNREADABLE-OBJECT</B></A> <P>
|
||
|
|
<P><B>Syntax:</B><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>print-unreadable-object</B> <I>(object stream <TT>&key</TT> type identity) <I>form</I><B>*</B></I> => <I><A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A></I><P>
|
||
|
|
<P>
|
||
|
|
<P><B>Arguments and Values:</B><P>
|
||
|
|
<P>
|
||
|
|
<I>object</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>; evaluated. <P>
|
||
|
|
<I>stream</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#stream_designator"><I>stream designator</I></A>; evaluated. <P>
|
||
|
|
<I>type</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>; evaluated. <P>
|
||
|
|
<I>identity</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>; evaluated. <P>
|
||
|
|
<I>forms</I>---an <A REL=DEFINITION HREF="26_glo_i.htm#implicit_progn"><I>implicit progn</I></A>. <P>
|
||
|
|
<P><B>Description:</B><P>
|
||
|
|
<P>
|
||
|
|
Outputs a printed representation of <I>object</I> on <I>stream</I>, beginning with ``<TT>#<</TT>'' and ending with ``<TT>></TT>''. Everything output to <I>stream</I> by the body <I>forms</I> is enclosed in the the angle brackets. If <I>type</I> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>, the output from <I>forms</I> is preceded by a brief description of the <I>object</I>'s <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> and a space character. If <I>identity</I> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>, the output from <I>forms</I> is followed by a space character and a representation of the <I>object</I>'s identity, typically a storage address. <P>
|
||
|
|
If either <I>type</I> or <I>identity</I> is not supplied, its value is <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. It is valid to omit the body <I>forms</I>. If <I>type</I> and <I>identity</I> are both true and there are no body <I>forms</I>, only one space character separates the type and the identity. <P>
|
||
|
|
<P><B>Examples:</B><P>
|
||
|
|
<P>
|
||
|
|
;; Note that in this example, the precise form of the output ;; is <A REL=DEFINITION HREF="26_glo_i.htm#implementation-dependent"><I>implementation-dependent</I></A>. <P>
|
||
|
|
<PRE>
|
||
|
|
(defmethod print-object ((obj airplane) stream)
|
||
|
|
(print-unreadable-object (obj stream :type t :identity t)
|
||
|
|
(princ (tail-number obj) stream)))
|
||
|
|
|
||
|
|
(prin1-to-string my-airplane)
|
||
|
|
=> "#<Airplane NW0773 36000123135>"
|
||
|
|
OR=> "#<FAA:AIRPLANE NW0773 17>"
|
||
|
|
</PRE>
|
||
|
|
</TT> <P>
|
||
|
|
<P><B>Affected By:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Exceptional Situations:</B><P>
|
||
|
|
<P>
|
||
|
|
If <A REL=DEFINITION HREF="v_pr_rda.htm#STprint-readablyST"><B>*print-readably*</B></A> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>, <A REL=DEFINITION HREF="#print-unreadable-object"><B>print-unreadable-object</B></A> signals an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_pr_not.htm#print-not-readable"><B>print-not-readable</B></A> without printing anything. <P>
|
||
|
|
<P><B>See Also:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Notes:</B> None.
|
||
|
|
<P>
|
||
|
|
<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/iss089.htm">DATA-IO:ADD-SUPPORT</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>
|