CLHS: Function STRING-TRIM, STRING-LEFT-TRIM...

#

Function STRING-TRIM, STRING-LEFT-TRIM, STRING-RIGHT-TRIM

Syntax:

string-trim character-bag string => trimmed-string

string-left-trim character-bag string => trimmed-string

string-right-trim character-bag string => trimmed-string

Arguments and Values:

character-bag---a sequence containing characters.

string---a string designator.

trimmed-string---a string.

Description:

string-trim returns a substring of string, with all characters in character-bag stripped off the beginning and end. string-left-trim is similar but strips characters off only the beginning; string-right-trim strips off only the end.

If no characters need to be trimmed from the string, then either string itself or a copy of it may be returned, at the discretion of the implementation.

All of these functions observe the fill pointer.

Examples:

     (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"

Side Effects: None.

Affected By:

The implementation.

Exceptional Situations: None.

See Also: None.

Notes: None.

The following X3J13 cleanup issue, not part of the specification, applies to this section:

- STRING-COERCION:MAKE-CONSISTENT

Copyright 1996-2005, LispWorks Ltd. All rights reserved.