19962016 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. string Robert Virding Bjarne Däcker 1 Bjarne Däcker 1996-09-28 A string.xml
string String processing functions.

This module provides functions for string processing.

Center a string.

Returns a string, where String is centered in the string and surrounded by blanks or Character. The resulting string has length Number.

Returns a string consisting of numbers of characters.

Returns a string consisting of Number characters Character. Optionally, the string can end with string Tail.

Return the index of the first occurrence of a character in a string.

Returns the index of the first occurrence of Character in String. Returns 0 if Character does not occur.

Concatenate two strings.

Concatenates String1 and String2 to form a new string String3, which is returned.

Copy a string.

Returns a string containing String repeated Number times.

Span characters at start of a string.

Returns the length of the maximum initial segment of String, which consists entirely of characters not from Chars.

Example:

> string:cspan("\t abcdef", " \t"). 0
Test string equality.

Returns true if String1 and String2 are equal, otherwise false.

Join a list of strings with separator.

Returns a string with the elements of StringList separated by the string in Separator.

Example:

> join(["one", "two", "three"], ", "). "one, two, three"
Adjust left end of a string.

Returns String with the length adjusted in accordance with Number. The left margin is fixed. If length(String) < Number, then String is padded with blanks or Characters.

Example:

> string:left("Hello",10,$.). "Hello....."
Return the length of a string.

Returns the number of characters in String.

Return the index of the last occurrence of a character in a string.

Returns the index of the last occurrence of Character in String. Returns 0 if Character does not occur.

Adjust right end of a string.

Returns String with the length adjusted in accordance with Number. The right margin is fixed. If the length of (String) < Number, then String is padded with blanks or Characters.

Example:

> string:right("Hello", 10, $.). ".....Hello"
Find the index of a substring.

Returns the position where the last occurrence of SubString begins in String. Returns 0 if SubString does not exist in String.

Example:

> string:rstr(" Hello Hello World World ", "Hello World"). 8
Span characters at start of a string.

Returns the length of the maximum initial segment of String, which consists entirely of characters from Chars.

Example:

> string:span("\t abcdef", " \t"). 5
Find the index of a substring.

Returns the position where the first occurrence of SubString begins in String. Returns 0 if SubString does not exist in String.

Example:

> string:str(" Hello Hello World World ", "Hello World"). 8
Strip leading or trailing characters.

Returns a string, where leading and/or trailing blanks or a number of Character have been removed. Direction, which can be left, right, or both, indicates from which direction blanks are to be removed. strip/1 is equivalent to strip(String, both).

Example:

> string:strip("...Hello.....", both, $.). "Hello"
Extract a substring.

Returns a substring of String, starting at position Start to the end of the string, or to and including position Stop.

Example:

sub_string("Hello World", 4, 8). "lo Wo"
Return a substring of a string.

Returns a substring of String, starting at position Start, and ending at the end of the string or at length Length.

Example:

> substr("Hello World", 4, 5). "lo Wo"
Extract subword.

Returns the word in position Number of String. Words are separated by blanks or Characters.

Example:

> string:sub_word(" Hello old boy !",3,$o). "ld b"
Returns a float whose text representation is the integers (ASCII values) in a string.

Argument String is expected to start with a valid text represented float (the digits are ASCII values). Remaining characters in the string after the float are returned in Rest.

Example:

> {F1,Fs} = string:to_float("1.0-1.0e-1"), > {F2,[]} = string:to_float(Fs), > F1+F2. 0.9 > string:to_float("3/2=1.5"). {error,no_float} > string:to_float("-1.5eX"). {-1.5,"eX"}
Returns an integer whose text representation is the integers (ASCII values) in a string.

Argument String is expected to start with a valid text represented integer (the digits are ASCII values). Remaining characters in the string after the integer are returned in Rest.

Example:

> {I1,Is} = string:to_integer("33+22"), > {I2,[]} = string:to_integer(Is), > I1-I2. 11 > string:to_integer("0.5"). {0,".5"} > string:to_integer("x=2"). {error,no_integer}
Convert case of string (ISO/IEC 8859-1).

The specified string or character is case-converted. Notice that the supported character set is ISO/IEC 8859-1 (also called Latin 1); all values outside this set are unchanged

Split string into tokens.

Returns a list of tokens in String, separated by the characters in SeparatorList.

Example:

> tokens("abc defxxghix jkl", "x "). ["abc", "def", "ghi", "jkl"]

Notice that, as shown in this example, two or more adjacent separator characters in String are treated as one. That is, there are no empty strings in the resulting list of tokens.

Count blank separated words.

Returns the number of words in String, separated by blanks or Character.

Example:

> words(" Hello old boy!", $o). 4
Notes

Some of the general string functions can seem to overlap each other. The reason is that this string package is the combination of two earlier packages and all functions of both packages have been retained.

Any undocumented functions in string are not to be used.