1
0
Fork 0
cl-sites/novaspec.org/cl/f_string-trim.html
2025-02-05 18:52:26 +01:00

292 lines
No EOL
6.6 KiB
HTML

<!DOCTYPE HTML>
<HTML LANG="en-us"
><HEAD
><TITLE
>string-trim, string-left-trim, string-right-trim | Common Lisp Nova Spec</TITLE
><META CHARSET="US-ASCII"
><LINK REL="canonical" HREF="f_string-trim.html"
><LINK REL="next" HREF="f_string_eq.html" TYPE="text/html" TITLE="string=, string/=, string&lt;, string&gt;, string&lt;=, string&gt;=, string-equal, string-not-equal, string-lessp, string-greaterp, string-not-greaterp, string-not-lessp"
><LINK REL="prev" HREF="f_string-upcase.html" TYPE="text/html" TITLE="string-upcase, string-downcase, string-capitalize, nstring-upcase, nstring-downcase, nstring-capitalize"
><LINK REL="up" HREF="16_2_Strings_Dictionary.html" TYPE="text/html" TITLE="16.2 Strings 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"
>&#8594; <A HREF="16_Strings.html"
>16. Strings</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="16_2_Strings_Dictionary.html"
>16.2 Strings Dictionary</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="f_string-trim.html"
>string-trim, string-left-trim, string-right-trim</A
></SPAN
></DIV
><DIV CLASS="apropos"
><DIV CLASS="apropos-io"
><A HREF="f_string-upcase.html" CLASS="prev"
>&#8592;</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_string_eq.html" CLASS="next"
>&#8594;</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="string-trim, string-left-trim, string-right-trim"
></SPAN
><B
>string-trim, string-left-trim, string-right-trim</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
><TABLE CELLSPACING="0" CELLPADDING="0" RULES="GROUPS" STYLE="margin: 1ex 0"
><TBODY
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
><B
>string-trim</B
> <SPAN CLASS="cmssi"
>character-bag</SPAN
> <SPAN CLASS="cmssi"
>string</SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <SPAN CLASS="cmssi"
>trimmed-string</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <B
>string-left-trim</B
> <SPAN CLASS="cmssi"
>character-bag</SPAN
> <SPAN CLASS="cmssi"
>string</SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <SPAN CLASS="cmssi"
>trimmed-string</SPAN
></TD
></TR
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE=";padding-right:3px"
> <B
>string-right-trim</B
> <SPAN CLASS="cmssi"
>character-bag</SPAN
> <SPAN CLASS="cmssi"
>string</SPAN
></TD
><TD ALIGN="LEFT" VALIGN="BASELINE" STYLE="padding-left:3px;"
> <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> <SPAN CLASS="cmssi"
>trimmed-string</SPAN
></TD
></TR
></TBODY
></TABLE
></DD
><DT
><B
>Arguments and Values</B
></DT
><DD
><P CLASS="j"
><VAR CLASS="param"
>character-bag</VAR
> &#8212; a <A HREF="26_1_Glossary.html#sequence"
><EM CLASS="term"
>sequence</EM
></A
> containing <A HREF="26_1_Glossary.html#character"
><EM CLASS="term"
>characters</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>string</VAR
> &#8212; a <A HREF="26_1_Glossary.html#string_designator"
><EM CLASS="term"
>string designator</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>trimmed-string</VAR
> &#8212; a <A HREF="26_1_Glossary.html#string"
><EM CLASS="term"
>string</EM
></A
>.</P
></DD
><DT
><B
>Description</B
></DT
><DD
><P CLASS="j"
><A HREF="f_string-trim.html" CLASS="funref"
><B
>string-trim</B
></A
> returns a substring of <VAR CLASS="param"
>string</VAR
>, with all characters in <VAR CLASS="param"
>character-bag</VAR
> stripped off the beginning and end. <A HREF="f_string-trim.html" CLASS="funref"
><B
>string-left-trim</B
></A
> is similar but strips characters off only the beginning; <A HREF="f_string-trim.html" CLASS="funref"
><B
>string-right-trim</B
></A
> strips off only the end. </P
><P CLASS="j"
>If no <A HREF="26_1_Glossary.html#character"
><EM CLASS="term"
>characters</EM
></A
> need to be trimmed from the <VAR CLASS="param"
>string</VAR
>, then either <VAR CLASS="param"
>string</VAR
> itself or a copy of it may be returned, at the discretion of the implementation. </P
><P CLASS="j"
>All of these <A HREF="26_1_Glossary.html#function"
><EM CLASS="term"
>functions</EM
></A
> observe the <A HREF="26_1_Glossary.html#fill_pointer"
><EM CLASS="term"
>fill pointer</EM
></A
>.</P
></DD
><DT
><B
>Examples</B
></DT
><DD
><PRE CLASS="screen"
> (string-trim "abc" "abcaakaaakabcaaa") <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> "kaaak"
(string-trim '(#\Space #\Tab #\Newline) " garbanzo beans
") <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> "garbanzo beans"
(string-trim " (*)" " ( *three (silly) words* ) ")
<SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> "three (silly) words"
(string-left-trim "abc" "labcabcabc") <SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> "labcabcabc"
(string-left-trim " (*)" " ( *three (silly) words* ) ")
<SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> "three (silly) words* ) "
(string-right-trim " (*)" " ( *three (silly) words* ) ")
<SPAN CLASS="cmsy"
><SPAN CLASS="arrow"
>&#8594;</SPAN
></SPAN
> " ( *three (silly) words"</PRE
></DD
><DT
><B
>Affected By</B
></DT
><DD
><P CLASS="j"
>The <A HREF="26_1_Glossary.html#implementation"
><EM CLASS="term"
>implementation</EM
></A
>.</P
></DD
></DL
></DIV
></DIV
><DIV CLASS="footer"
><DIV CLASS="btmnav"
><A HREF="f_string-upcase.html" CLASS="prev"
>&#8592;</A
><A HREF="f_string_eq.html" CLASS="next"
>&#8594;</A
></DIV
><DIV CLASS="trail"
>Conversion to HTML copyright 2023 by Gilbert Baumann</DIV
></DIV
></DIV
><SCRIPT
>domReady();</SCRIPT
></BODY
></HTML
>