1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_clear_.htm
2024-04-01 10:24:07 +02:00

90 lines
4.5 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 CLEAR-INPUT</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_listen.htm">
<LINK REL=UP HREF="c_stream.htm">
<LINK REL=NEXT HREF="f_finish.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_listen.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_stream.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_finish.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="clear-input"><I>Function</I> <B>CLEAR-INPUT</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>clear-input</B> <I><TT>&amp;optional</TT> input-stream</I> =&gt; <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>input-stream</I>---an <A REL=DEFINITION HREF="26_glo_i.htm#input"><I>input</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#stream_designator"><I>stream designator</I></A>. The default is <A REL=DEFINITION HREF="26_glo_s.htm#standard_input"><I>standard input</I></A>. <P>
<P><B>Description:</B><P>
<P>
Clears any available input from <I>input-stream</I>. <P>
If <A REL=DEFINITION HREF="#clear-input"><B>clear-input</B></A> does not make sense for <I>input-stream</I>, then <A REL=DEFINITION HREF="#clear-input"><B>clear-input</B></A> does nothing. <P>
<P><B>Examples:</B><P>
<PRE>
;; The exact I/O behavior of this example might vary from implementation
;; to implementation depending on the kind of interactive buffering that
;; occurs. (The call to SLEEP here is intended to help even out the
;; differences in implementations which do not do line-at-a-time buffering.)
(defun read-sleepily (&amp;optional (clear-p nil) (zzz 0))
(list (progn (print '&gt;) (read))
;; Note that input typed within the first ZZZ seconds
;; will be discarded.
(progn (print '&gt;)
(if zzz (sleep zzz))
(print '&gt;&gt;)
(if clear-p (clear-input))
(read))))
(read-sleepily)
&gt;&gt; &gt; 10
&gt;&gt; &gt;
&gt;&gt; &gt;&gt; 20
=&gt; (10 20)
(read-sleepily t)
&gt;&gt; &gt; 10
&gt;&gt; &gt;
&gt;&gt; &gt;&gt; 20
=&gt; (10 20)
(read-sleepily t 10)
&gt;&gt; &gt; 10
&gt;&gt; &gt; 20 ; Some implementations won't echo typeahead here.
&gt;&gt; &gt;&gt; 30
=&gt; (10 30)
</PRE>
</TT> <P>
<P><B>Side Effects:</B><P>
<P>
The <I>input-stream</I> is modified. <P>
<P><B>Affected By:</B><P>
<P>
<A REL=DEFINITION HREF="v_debug_.htm#STstandard-inputST"><B>*standard-input*</B></A> <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>input-stream</I> is not a <A REL=DEFINITION HREF="26_glo_s.htm#stream_designator"><I>stream designator</I></A>. <P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_finish.htm#clear-output"><B>clear-output</B></A> <P>
<P><B>Notes:</B> None.
<P>
<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>