std.string
String handling functions. Objects of types string, wstring, and dstring are value types and cannot be mutated element-by-element. For using mutation during building strings, use char[], wchar[], or dchar[]. The *string types are preferable because they don't exhibit undesired aliasing, thus making code more robust. License:Boost License 1.0. Authors:
Walter Bright, Andrei Alexandrescu Copyright Digital Mars 2007 - 2009. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at ) http:
//www.boost.org/LICENSE_1_0.txt
- Thrown on errors in string functions.
- 0..9A..F
- 0..9
- 0..7
- a..z
- A..Za..z
- A..Z
- ASCII whitespace
- UTF line separator
- UTF paragraph separator
- Newline sequence for this system
- Returns true if c is whitespace
- Compare two strings. cmp is case sensitive, icmp is case
insensitive.
Returns: < 0 s1 < s2 = 0 s1 == s2 > 0 s1 > s2 - Convert array of chars s[] to a C-style 0-terminated string. s[] must not contain embedded 0's.
- Flag indicating whether a search is case-sensitive.
- indexOf: find first occurrence of c in string s. lastIndexOf: find last occurrence of c in string s. CaseSensitive.yes means the searches are case sensitive.
Returns:
Index in s where c is found, -1 if not found. - indexOf find first occurrence of sub[] in string s[].
lastIndexOf find last occurrence of sub[] in string s[].
CaseSensitive cs controls whether the comparisons are case
sensitive or not.
Returns:
Index in s where sub is found, -1 if not found. - Convert string s[] to lower case.
- Converts s to lowercase in place.
- Convert string s[] to upper case.
- Converts s to uppercase in place.
- Capitalize first character of string s[], convert rest of string s[] to lower case.
- Capitalize all words in string s[]. Remove leading and trailing whitespace. Replace all sequences of whitespace with a single space.
- Return a string that consists of s[] repeated n times.
- Concatenate all the strings in words[] together into one string; use sep[] as the separator.
- Split s[] into an array of words, using whitespace as delimiter.
- Split s[] into an array of words, using delim[] as the delimiter.
- Split s[] into an array of lines, using CR, LF, or CR-LF as the delimiter. The delimiter is not included in the line.
- Strips leading or trailing whitespace, or both.
- Returns s[] sans trailing delimiter[], if any. If delimiter[] is null, removes trailing CR, LF, or CRLF, if any.
- If longer.startsWith(shorter), returns longer[shorter.length .. $]. Otherwise, returns longer.
- Returns s[] sans trailing character, if there is one. If last two characters are CR-LF, then both are removed.
- Left justify, right justify, or center string s[] in field width chars wide.
- Same as rjustify(), but fill with '0's.
- Replace occurrences of from[] with to[] in s[].
- Return a string that is s[] with slice[] replaced by replacement[].
- Insert sub[] into s[] at location index.
- Count up all instances of sub[] in s[].
- Replace tabs with the appropriate number of spaces. tabsize is the distance between tab stops.
- Replace spaces in string s with the optimal number of tabs.
Trailing spaces or tabs in a line are removed.
Parameters:
string s String to convert. int tabsize Tab columns are tabsize spaces apart. tabsize defaults to 8. - Construct translation table for translate().
BUG:
only works with ASCII - Translate characters in s[] using table created by maketrans().
Delete chars in delchars[].
BUG:
only works with ASCII - Format arguments into a string.
- Format arguments into string s which must be large
enough to hold the result. Throws RangeError if it is not.
Returns:
s - See if character c is in the pattern.
Patterns:
A pattern is an array of characters much like a character class in regular expressions. A sequence of characters can be given, such as "abcde". The '-' can represent a range of characters, as "a-e" represents the same pattern as "abcde". "a-fA-F0-9" represents all the hex characters. If the first character of a pattern is '^', then the pattern is negated, i.e. "^0-9" means any character except a digit. The functions inPattern, countchars, removeschars, and squeeze use patterns. Note:
In the future, the pattern syntax may be improved to be more like regular expression character classes. - See if character c is in the intersection of the patterns.
- Count characters in s that match pattern.
- Return string that is s with all characters removed that match pattern.
- Return string where sequences of a character in s[] from pattern[] are replaced with a single instance of that character. If pattern is null, it defaults to all characters.
- Finds the position pos of the first character in s that does not match pattern (in the terminology used by
inPattern). Updates s =
s[pos..$]. Returns the slice from the beginning of the original
(before update) string up to, and excluding, pos.
Example:
string s = "123abc"; string t = munch(s, "0123456789"); assert(t == "123" && s == "abc"); t = munch(s, "0123456789"); assert(t == "" && s == "abc");
The munch function is mostly convenient for skipping certain category of characters (e.g. whitespace) when parsing strings. (In such cases, the return value is not used.) - Return string that is the 'successor' to s[]. If the rightmost character is a-zA-Z0-9, it is incremented within its case or digits. If it generates a carry, the process is repeated with the one to its immediate left.
- Replaces characters in str[] that are in from[]
with corresponding characters in to[] and returns the resulting
string.
Parameters:
Modifiers:string modifiers a string of modifier characters
Modifier Description c Complement the list of characters in from[] d Removes matching characters with no corresponding replacement in to[] s Removes adjacent duplicates in the replaced characters - [in] string s can be formatted in the following ways:
Integer Whole Number:
(for byte, ubyte, short, ushort, int, uint, long, and ulong)
['+'|'-']digit(s)[U|L|UL]
Examples:
123, 123UL, 123L, +123U, -123L Floating-Point Number: (for float, double, real, ifloat, idouble, and ireal) ['+'|'-']digit(s)[.][digit(s)][[e-|e+]digit(s)][i|f|L|Li|fi]] or [nan|nani|inf|-inf] Examples:
+123., -123.01, 123.3e-10f, 123.3e-10fi, 123.3e-10L (for cfloat, cdouble, and creal) ['+'|'-']digit(s)[.][digit(s)][[e-|e+]digit(s)][+] [digit(s)[.][digit(s)][[e-|e+]digit(s)][i|f|L|Li|fi]] or [nan|nani|nan+nani|inf|-inf] Examples:
nan, -123e-1+456.9e-10Li, +123e+10+456i, 123+456 [in] bool bAllowSep False by default, but when set to true it will accept the separator characters "," and "" within the string, but these characters should be stripped from the string before using any of the conversion functions like toInt(), toFloat(), and etc else an error will occur. Also please note, that no spaces are allowed within the string anywhere whether it's a leading, trailing, or embedded space(s), thus they too must be stripped from the string before using this function, or any of the conversion functions. - Allow any object as a parameter
- Check only the first parameter, all others will be ignored.
- Soundex algorithm.
The Soundex algorithm converts a word into 4 characters
based on how the word sounds phonetically. The idea is that
two spellings that sound alike will have the same Soundex
value, which means that Soundex can be used for fuzzy matching
of names.
Parameters:
Returns:string string String to convert to Soundex representation. char[] buffer Optional 4 char array to put the resulting Soundex characters into. If null, the return value buffer will be allocated on the heap.
The four character array with the Soundex result in it. Returns null if there is no Soundex representation for the string. See Also:
Wikipedia, The Soundex Indexing System BUGS:
Only works well with English names. There are other arguably better Soundex algorithms, but this one is the standard one. - Construct an associative array consisting of all
abbreviations that uniquely map to the strings in values.
This is useful in cases where the user is expected to type
in one of a known set of strings, and the program will helpfully
autocomplete the string once sufficient characters have been
entered that uniquely identify it.
Example:
import std.stdio; import std.string; void main() { static string[] list = [ "food", "foxy" ]; auto abbrevs = std.string.abbrev(list); foreach (key, value; abbrevs) { writefln("%s => %s", key, value); } }
produces the output:fox => foxy food => food foxy => foxy foo => food
- Compute column number after string if string starts in the leftmost column, which is numbered starting from 0.
- Wrap text into a paragraph.
The input text string s is formed into a paragraph
by breaking it up into a sequence of lines, delineated
by \n, such that the number of columns is not exceeded
on each line.
The last line is terminated with a \n.
Parameters:
Returns:string s text string to be wrapped int columns maximum number of columns in the paragraph string firstindent string used to indent first line of the paragraph string indent string to use to indent following lines of the paragraph int tabsize column spacing of tabs
The resulting paragraph. -
- Range primitives