422 lines
No EOL
8.2 KiB
HTML
422 lines
No EOL
8.2 KiB
HTML
<!DOCTYPE HTML>
|
|
<HTML LANG="en-us"
|
|
><HEAD
|
|
><TITLE
|
|
>read-line | Common Lisp Nova Spec</TITLE
|
|
><META CHARSET="US-ASCII"
|
|
><LINK REL="canonical" HREF="f_read-line.html"
|
|
><LINK REL="next" HREF="f_write-string.html" TYPE="text/html" TITLE="write-string, write-line"
|
|
><LINK REL="prev" HREF="f_write-char.html" TYPE="text/html" TITLE="write-char"
|
|
><LINK REL="up" HREF="21_2_Streams_Dictionary.html" TYPE="text/html" TITLE="21.2 Streams Dictionary"
|
|
><LINK REL="start" HREF="index.html" TYPE="text/html" TITLE="Common Lisp Nova Spec"
|
|
><META NAME="VIEWPORT" CONTENT="width=device-width, initial-scale=1.0"
|
|
><LINK REL="STYLESHEET" HREF="dpans.css%3F3909942064.css"
|
|
><SCRIPT SRC="dpans.js%3F3909942064"
|
|
></SCRIPT
|
|
><SCRIPT SRC="apropos.js%3F3909942064"
|
|
></SCRIPT
|
|
></HEAD
|
|
><BODY
|
|
><DIV
|
|
><DIV CLASS="topnav"
|
|
><DIV CLASS="breadcrumb"
|
|
><SPAN CLASS="breadcrumb-item"
|
|
><A HREF="index.html"
|
|
>Common Lisp Nova Spec</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="21_Streams.html"
|
|
>21. Streams</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="21_2_Streams_Dictionary.html"
|
|
>21.2 Streams Dictionary</A
|
|
></SPAN
|
|
> <SPAN CLASS="breadcrumb-item"
|
|
>→ <A HREF="f_read-line.html"
|
|
>read-line</A
|
|
></SPAN
|
|
></DIV
|
|
><DIV CLASS="apropos"
|
|
><DIV CLASS="apropos-io"
|
|
><A HREF="f_write-char.html" CLASS="prev"
|
|
>←</A
|
|
><SPAN ID="apropos-label"
|
|
>Apropos </SPAN
|
|
><INPUT ID="apropos" AUTOFOCUS="AUTOFOCUS" PLACEHOLDER="Type here to search" ONINPUT="aproposInput(this);" ONKEYUP="aproposKeyup(event);" ONCHANGE="aproposChange(this);" ONFOCUS="aproposFocus(this);" ONFOCUSOUT="aproposFocusout(this);"
|
|
><A HREF="f_write-string.html" CLASS="next"
|
|
>→</A
|
|
></DIV
|
|
><DIV ID="apropos-res"
|
|
></DIV
|
|
></DIV
|
|
></DIV
|
|
><DIV CLASS="matter"
|
|
><DIV CLASS="com"
|
|
><DIV CLASS="begincom"
|
|
><HR
|
|
><TABLE WIDTH="100%" CELLSPACING="0" CELLPADDING="0"
|
|
><TR
|
|
><TD ALIGN="LEFT" VALIGN="BASELINE" WIDTH="100%" CLASS="name"
|
|
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="read-line"
|
|
></SPAN
|
|
><B
|
|
>read-line</B
|
|
></TD
|
|
><TD ALIGN="RIGHT" VALIGN="BASELINE" WIDTH="0" NOWRAP="NOWRAP" CLASS="ftype"
|
|
><I
|
|
>Function</I
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
></DIV
|
|
><UL CLASS="subtoc"
|
|
></UL
|
|
><DL
|
|
><DT
|
|
><B
|
|
>Syntax</B
|
|
></DT
|
|
><DD
|
|
><DIV
|
|
><B
|
|
>read-line</B
|
|
> <SPAN CLASS="cmtt"
|
|
>&optional</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>input-stream</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>eof-error-p</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>eof-value</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>recursive-p</SPAN
|
|
> </DIV
|
|
><DIV
|
|
><SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>line,</SPAN
|
|
> <SPAN CLASS="cmssi"
|
|
>missing-newline-p</SPAN
|
|
></DIV
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Arguments and Values</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>input-stream</VAR
|
|
> — an <A HREF="26_1_Glossary.html#input"
|
|
><EM CLASS="term"
|
|
>input</EM
|
|
></A
|
|
> <A HREF="26_1_Glossary.html#stream_designator"
|
|
><EM CLASS="term"
|
|
>stream designator</EM
|
|
></A
|
|
>. The default is <A HREF="26_1_Glossary.html#standard_input"
|
|
><EM CLASS="term"
|
|
>standard input</EM
|
|
></A
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>eof-error-p</VAR
|
|
> — a <A HREF="26_1_Glossary.html#generalized_boolean"
|
|
><EM CLASS="term"
|
|
>generalized boolean</EM
|
|
></A
|
|
>. The default is <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>eof-value</VAR
|
|
> — an <A HREF="26_1_Glossary.html#object"
|
|
><EM CLASS="term"
|
|
>object</EM
|
|
></A
|
|
>. The default is <SPAN CLASS="misc"
|
|
><B
|
|
>nil</B
|
|
></SPAN
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>recursive-p</VAR
|
|
> — a <A HREF="26_1_Glossary.html#generalized_boolean"
|
|
><EM CLASS="term"
|
|
>generalized boolean</EM
|
|
></A
|
|
>. The default is <A HREF="26_1_Glossary.html#false"
|
|
><EM CLASS="term"
|
|
>false</EM
|
|
></A
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>line</VAR
|
|
> — a <A HREF="26_1_Glossary.html#string"
|
|
><EM CLASS="term"
|
|
>string</EM
|
|
></A
|
|
> or the <VAR CLASS="param"
|
|
>eof-value</VAR
|
|
>. </P
|
|
><P CLASS="j"
|
|
><VAR CLASS="param"
|
|
>missing-newline-p</VAR
|
|
> — a <A HREF="26_1_Glossary.html#generalized_boolean"
|
|
><EM CLASS="term"
|
|
>generalized boolean</EM
|
|
></A
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Description</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
>Reads from <VAR CLASS="param"
|
|
>input-stream</VAR
|
|
> a line of text that is terminated by a <A HREF="26_1_Glossary.html#newline"
|
|
><EM CLASS="term"
|
|
>newline</EM
|
|
></A
|
|
> or <A HREF="26_1_Glossary.html#end_of_file"
|
|
><EM CLASS="term"
|
|
>end of file</EM
|
|
></A
|
|
>. </P
|
|
><P CLASS="j"
|
|
>If <VAR CLASS="param"
|
|
>recursive-p</VAR
|
|
> is <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
>, this call is expected to be embedded in a higher-level call to <A HREF="f_read.html" CLASS="funref"
|
|
><B
|
|
>read</B
|
|
></A
|
|
> or a similar <A HREF="26_1_Glossary.html#function"
|
|
><EM CLASS="term"
|
|
>function</EM
|
|
></A
|
|
> used by the <A HREF="26_1_Glossary.html#Lisp_reader"
|
|
><EM CLASS="term"
|
|
>Lisp reader</EM
|
|
></A
|
|
>. </P
|
|
><P CLASS="j"
|
|
>The <A HREF="26_1_Glossary.html#primary_value"
|
|
><EM CLASS="term"
|
|
>primary value</EM
|
|
></A
|
|
>, <VAR CLASS="param"
|
|
>line</VAR
|
|
>, is the line that is read, represented as a <A HREF="26_1_Glossary.html#string"
|
|
><EM CLASS="term"
|
|
>string</EM
|
|
></A
|
|
> (without the trailing <A HREF="26_1_Glossary.html#newline"
|
|
><EM CLASS="term"
|
|
>newline</EM
|
|
></A
|
|
>, if any). If <VAR CLASS="param"
|
|
>eof-error-p</VAR
|
|
> is <A HREF="26_1_Glossary.html#false"
|
|
><EM CLASS="term"
|
|
>false</EM
|
|
></A
|
|
> and the <A HREF="26_1_Glossary.html#end_of_file"
|
|
><EM CLASS="term"
|
|
>end of file</EM
|
|
></A
|
|
> for <VAR CLASS="param"
|
|
>input-stream</VAR
|
|
> is reached before any <A HREF="26_1_Glossary.html#character"
|
|
><EM CLASS="term"
|
|
>characters</EM
|
|
></A
|
|
> are read, <VAR CLASS="param"
|
|
>eof-value</VAR
|
|
> is returned as the <VAR CLASS="param"
|
|
>line</VAR
|
|
>. </P
|
|
><P CLASS="j"
|
|
>The <A HREF="26_1_Glossary.html#secondary_value"
|
|
><EM CLASS="term"
|
|
>secondary value</EM
|
|
></A
|
|
>, <VAR CLASS="param"
|
|
>missing-newline-p</VAR
|
|
>, is a <A HREF="26_1_Glossary.html#generalized_boolean"
|
|
><EM CLASS="term"
|
|
>generalized boolean</EM
|
|
></A
|
|
> that is <A HREF="26_1_Glossary.html#false"
|
|
><EM CLASS="term"
|
|
>false</EM
|
|
></A
|
|
> if the <VAR CLASS="param"
|
|
>line</VAR
|
|
> was terminated by a <A HREF="26_1_Glossary.html#newline"
|
|
><EM CLASS="term"
|
|
>newline</EM
|
|
></A
|
|
>, or <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
> if the <VAR CLASS="param"
|
|
>line</VAR
|
|
> was terminated by the <A HREF="26_1_Glossary.html#end_of_file"
|
|
><EM CLASS="term"
|
|
>end of file</EM
|
|
></A
|
|
> for <VAR CLASS="param"
|
|
>input-stream</VAR
|
|
> (or if the <VAR CLASS="param"
|
|
>line</VAR
|
|
> is the <VAR CLASS="param"
|
|
>eof-value</VAR
|
|
>).</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Examples</B
|
|
></DT
|
|
><DD
|
|
><PRE CLASS="screen"
|
|
> (setq a "line 1
|
|
line2")
|
|
<SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> "line 1
|
|
line2"
|
|
(read-line (setq input-stream (make-string-input-stream a)))
|
|
<SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> "line 1", <A HREF="26_1_Glossary.html#false"
|
|
><EM CLASS="term"
|
|
>false</EM
|
|
></A
|
|
>
|
|
(read-line input-stream)
|
|
<SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> "line2", <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
>
|
|
(read-line input-stream nil nil)
|
|
<SPAN CLASS="cmsy"
|
|
><SPAN CLASS="arrow"
|
|
>→</SPAN
|
|
></SPAN
|
|
> NIL, <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
></PRE
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Affected By</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><A HREF="v_debug-io.html" CLASS="varref"
|
|
><B
|
|
>*standard-input*</B
|
|
></A
|
|
>, <A HREF="v_terminal-io.html" CLASS="varref"
|
|
><B
|
|
>*terminal-io*</B
|
|
></A
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Exceptional Situations</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
>If an <A HREF="26_1_Glossary.html#end_of_file"
|
|
><EM CLASS="term"
|
|
>end of file</EM
|
|
></A
|
|
><SPAN CLASS="meaning"
|
|
><SUB CLASS="sub"
|
|
><SPAN CLASS="cmr"
|
|
>2</SPAN
|
|
></SUB
|
|
></SPAN
|
|
> occurs before any characters are read in the line, an error is signaled if <VAR CLASS="param"
|
|
>eof-error-p</VAR
|
|
> is <A HREF="26_1_Glossary.html#true"
|
|
><EM CLASS="term"
|
|
>true</EM
|
|
></A
|
|
>.</P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>See Also</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
><A HREF="f_read.html" CLASS="funref"
|
|
><B
|
|
>read</B
|
|
></A
|
|
></P
|
|
></DD
|
|
><DT
|
|
><B
|
|
>Notes</B
|
|
></DT
|
|
><DD
|
|
><P CLASS="j"
|
|
>The corresponding output function is <A HREF="f_write-string.html" CLASS="funref"
|
|
><B
|
|
>write-line</B
|
|
></A
|
|
>.</P
|
|
></DD
|
|
></DL
|
|
></DIV
|
|
></DIV
|
|
><DIV CLASS="footer"
|
|
><DIV CLASS="btmnav"
|
|
><A HREF="f_write-char.html" CLASS="prev"
|
|
>←</A
|
|
><A HREF="f_write-string.html" CLASS="next"
|
|
>→</A
|
|
></DIV
|
|
><DIV CLASS="trail"
|
|
>Conversion to HTML copyright 2023 by Gilbert Baumann</DIV
|
|
></DIV
|
|
></DIV
|
|
><SCRIPT
|
|
>domReady();</SCRIPT
|
|
></BODY
|
|
></HTML
|
|
> |