47 lines
4.5 KiB
HTML
47 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: Section 1.4.4.20</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="01_dds.htm">
|
|
<LINK REL=UP HREF="01_dd.htm">
|
|
<LINK REL=NEXT HREF="01_ddta.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="01_dds.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="01_dd.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="01_ddta.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<H2>
|
|
1.4.4.20 The ``Syntax'' Section of a Dictionary Entry</H2> <P>
|
|
This section describes how to use the <A REL=DEFINITION HREF="26_glo_d.htm#defined_name"><I>defined name</I></A> in code. The ``Syntax'' description for a <A REL=DEFINITION HREF="26_glo_g.htm#generic_function"><I>generic function</I></A> describes the <A REL=DEFINITION HREF="26_glo_l.htm#lambda_list"><I>lambda list</I></A> of the <A REL=DEFINITION HREF="26_glo_g.htm#generic_function"><I>generic function</I></A> itself, while the ``Method Signatures'' describe the <A REL=DEFINITION HREF="26_glo_l.htm#lambda_list"><I>lambda lists</I></A> of the defined <A REL=DEFINITION HREF="26_glo_m.htm#method"><I>methods</I></A>. The ``Syntax'' description for an <A REL=DEFINITION HREF="26_glo_o.htm#ordinary_function"><I>ordinary function</I></A>, a <A REL=DEFINITION HREF="26_glo_m.htm#macro"><I>macro</I></A>, or a <A REL=DEFINITION HREF="26_glo_s.htm#special_operator"><I>special operator</I></A> describes its <A REL=DEFINITION HREF="26_glo_p.htm#parameter"><I>parameters</I></A>. <P>
|
|
For example, an <A REL=DEFINITION HREF="26_glo_o.htm#operator"><I>operator</I></A> description might say: <P>
|
|
|
|
<B>F</B> <I>x y <TT>&optional</TT> z <TT>&key</TT> k</I><P>
|
|
<P>
|
|
This description indicates that the function <B>F</B> has two required parameters, <I>x</I> and <I>y</I>. In addition, there is an optional parameter <I>z</I> and a keyword parameter <I>k</I>. <P>
|
|
For <A REL=DEFINITION HREF="26_glo_m.htm#macro"><I>macros</I></A> and <A REL=DEFINITION HREF="26_glo_s.htm#special_operator"><I>special operators</I></A>, syntax is given in modified BNF notation; see <A REL=CHILD HREF="01_dab.htm">Section 1.4.1.2 (Modified BNF Syntax)</A>. For <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>functions</I></A> a <A REL=DEFINITION HREF="26_glo_l.htm#lambda_list"><I>lambda list</I></A> is given. In both cases, however, the outermost parentheses are omitted, and default value information is omitted. <P>
|
|
|
|
|
|
<A REL=CHILD HREF="01_ddta.htm"><H2>
|
|
1.4.4.20.1 Special ``Syntax'' Notations for Overloaded Operators</H2></A><P>
|
|
|
|
<A REL=CHILD HREF="01_ddtb.htm"><H2>
|
|
1.4.4.20.2 Naming Conventions for Rest Parameters</H2></A><P>
|
|
|
|
<A REL=CHILD HREF="01_ddtc.htm"><H2>
|
|
1.4.4.20.3 Requiring Non-Null Rest Parameters in the ``Syntax'' Section</H2></A><P>
|
|
|
|
<A REL=CHILD HREF="01_ddtd.htm"><H2>
|
|
1.4.4.20.4 Return values in the ``Syntax'' Section</H2></A><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>
|