72 lines
5 KiB
HTML
72 lines
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 STRING-TRIM, STRING-LEFT-TRIM...</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_stg_up.htm">
|
|
<LINK REL=UP HREF="c_string.htm">
|
|
<LINK REL=NEXT HREF="f_stgeq_.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_stg_up.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_string.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_stgeq_.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="string-trim"><A NAME="string-left-trim"><A NAME="string-right-trim"><I>Function</I> <B>STRING-TRIM, STRING-LEFT-TRIM, STRING-RIGHT-TRIM</B></A></A></A> <P>
|
|
<P><B>Syntax:</B><P>
|
|
|
|
<B>string-trim</B> <I>character-bag string</I> => <I>trimmed-string</I><P>
|
|
|
|
<B>string-left-trim</B> <I>character-bag string</I> => <I>trimmed-string</I><P>
|
|
|
|
<B>string-right-trim</B> <I>character-bag string</I> => <I>trimmed-string</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>character-bag</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#sequence"><I>sequence</I></A> containing <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A>. <P>
|
|
<I>string</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string_designator"><I>string designator</I></A>. <P>
|
|
<I>trimmed-string</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
<A REL=DEFINITION HREF="#string-trim"><B>string-trim</B></A> returns a substring of <I>string</I>, with all characters in <I>character-bag</I> stripped off the beginning and end. <A REL=DEFINITION HREF="#string-left-trim"><B>string-left-trim</B></A> is similar but strips characters off only the beginning; <A REL=DEFINITION HREF="#string-right-trim"><B>string-right-trim</B></A> strips off only the end. <P>
|
|
If no <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> need to be trimmed from the <I>string</I>, then either <I>string</I> itself or a copy of it may be returned, at the discretion of the implementation. <P>
|
|
All of these <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>functions</I></A> observe the <A REL=DEFINITION HREF="26_glo_f.htm#fill_pointer"><I>fill pointer</I></A>. <P>
|
|
<P><B>Examples:</B><P>
|
|
|
|
<PRE>
|
|
(string-trim "abc" "abcaakaaakabcaaa") => "kaaak"
|
|
(string-trim '(#\Space #\Tab #\Newline) " garbanzo beans
|
|
") => "garbanzo beans"
|
|
(string-trim " (*)" " ( *three (silly) words* ) ")
|
|
=> "three (silly) words"
|
|
|
|
(string-left-trim "abc" "labcabcabc") => "labcabcabc"
|
|
(string-left-trim " (*)" " ( *three (silly) words* ) ")
|
|
=> "three (silly) words* ) "
|
|
|
|
(string-right-trim " (*)" " ( *three (silly) words* ) ")
|
|
=> " ( *three (silly) words"
|
|
</PRE>
|
|
</TT> <P><B>Side Effects:</B> None.
|
|
<P>
|
|
<P><B>Affected By:</B><P>
|
|
<P>
|
|
The <A REL=DEFINITION HREF="26_glo_i.htm#implementation"><I>implementation</I></A>. <P>
|
|
<P><B>Exceptional Situations:</B> None.
|
|
<P>
|
|
<P><B>See Also:</B> None.
|
|
<P>
|
|
<P><B>Notes:</B> None.
|
|
<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/iss329.htm">STRING-COERCION:MAKE-CONSISTENT</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>
|