StrUtils unit

Various string handling routines.

Procedures and functions

`AddChar`	function	Add characters to the left of a string till a certain length.
`AddCharR`	function	Add chars at the end of a string till it reaches a certain length.
`AnsiContainsStr`	function	Checks whether a string contains a given substring.
`AnsiContainsText`	function	Check whether a string contains a certain substring, ignoring case.
`AnsiEndsStr`	function	Check whether a string ends with a certain substring.
`AnsiEndsText`	function	Check whether a string ends with a certain substring, ignoring case.
`AnsiIndexStr`	function	Searches, observing case, for a string in an array of strings.
`AnsiIndexText`	function	Searches, case insensitive, for a string in an array of strings.
`AnsiLeftStr`	function	Copies a number of characters starting at the left of a string.
`AnsiMatchStr`	function	Check whether a string occurs in an array of strings, observing case.
`AnsiMatchText`	function	Check whether a string occurs in an array of strings, disregarding case.
`AnsiMidStr`	function	Returns a number of characters copied from a given location in a string.
`AnsiProperCase`	function	Pretty-Print a string: make lowercase and capitalize first letters of words.
`AnsiReplaceStr`	function	Search and replace all occurrences of a string, case sensitive.
`AnsiReplaceText`	function	Search and replace all occurrences of a string, case insensitive.
`AnsiResemblesText`	function	Check whether 2 strings resemble each other.
`AnsiReverseString`	function	Reverse the letters in a string.
`AnsiRightStr`	function	Copies a number of characters starting at the right of a string.
`AnsiStartsStr`	function	Check whether a string starts with a given substring, observing case.
`AnsiStartsText`	function	Check whether a string starts with a given substring, ignoring case.
`BinToHex`	procedure	Convert a binary buffer to a hexadecimal string.
`ContainsStr`	function	Check whether one text contains another (case sensitive).
`ContainsText`	function	Check whether one text contains another (case insensitive).
`Copy2Space`	function	Returns all characters in a string till the first space character (not included).
`Copy2SpaceDel`	function	Deletes and returns all characters in a string till the first space character (not included).
`Copy2Symb`	function	Returns all characters in a string till a given character (not included).
`Copy2SymbDel`	function	Deletes and returns all characters in a string till a given character (not included).
`Dec2Numb`	function	Convert a decimal number to a string representation, using given a base.
`DecodeSoundexInt`	function	Decodes the integer representation of a soundex code and returns the original soundex code.
`DecodeSoundexWord`	function	Decodes the word-sized representation of a soundex code and returns the original soundex code.
`DelChars`	function	Delete all occurrences of a given character from a string.
`DelSpace`	function	Delete all occurrences of a space from a string.
`DelSpace1`	function	Reduces sequences of space characters to 1 space character.
`DupeString`	function	Creates and concatenates N copies of a string.
`EndsStr`	function	Check whether one string ends with another.
`EndsText`	function	Check whether one text ends with another.
`ExtractDelimited`	function	Extract the N-th delimited part from a string.
`ExtractSubstr`	function	Extract a word from a string, starting at a given position in the string.
`ExtractWord`	function	Extract the N-th word out of a string.
`ExtractWordPos`	function	Extract a word from a string, and return the position where it was located in the string.
`FindMatchesBoyerMooreCaseInSensitive`	function	Find case-insensitive matches of a string using a Boyer-Moore algorithm.
`FindMatchesBoyerMooreCaseSensitive`	function	Find case-sensitive matches of a string using a Boyer-Moore algorithm.
`FindPart`	function	Search for a substring in a string, using wildcards.
`GetCmdLineArg`	function	Returns the command-line argument following the given switch.
`Hex2Dec`	function	Converts a hexadecimal string to a decimal value.
`Hex2Dec64`	function	Convert hexadecimal value to 64-bit integer.
`HexToBin`	function	Convert a hexadecimal string to a binary buffer.
`IfThen`	function	Returns one of two strings, depending on a boolean expression.
`in(Ansistring,):Boolean`	operator
`in(UnicodeString,):Boolean`	operator	Check presence of string in an array of strings.
`IndexStr`	function	Searches, observing case, for a string in an array of strings.
`IndexText`	function	Index of text in a list of values.
`IntToBin`	function	Converts an integer to a binary string representation, inserting spaces at fixed locations.
`IntToRoman`	function	Represent an integer with roman numerals.
`IsEmptyStr`	function	Check whether a string is empty, disregarding whitespace characters.
`IsWild`	function	Check whether a string matches a wildcard search expression.
`IsWordPresent`	function	Check for the presence of a word in a string.
`LeftBStr`	function	Copies Count characters starting at the left of a string.
`LeftStr`	function	Copies Count characters starting at the left of a string.
`MatchStr`	function	Check whether a string occurs in an array of strings, observing case.
`MatchText`	function	Check if a string is in a list of values.
`MidBStr`	function	Copies a number of characters starting at a given position in a string.
`MidStr`	function	Copies a number of characters starting at a given position in a string.
`NaturalCompareText`	function	Compare using natural sort.
`NPos`	function	Returns the position of the N-th occurrence of a substring in a string.
`Numb2Dec`	function	Converts a string representation of a number to its numerical value, given a certain base.
`Numb2USA`	function	Insert thousand separators.
`PadCenter`	function	Pad the string to a certain length, so the string is centered.
`PadLeft`	function	Add spaces to the left of a string till a certain length is reached.
`PadRight`	function	Add spaces to the right of a string till a certain length is reached.
`PosEx`	function	Search for the occurrence of a character in a string, starting at a certain position.
`PosSet`	function	Return the position in a string of any character out of a set of characters.
`PosSetEx`	function	Return the position in a string of any character out of a set of characters, starting at a certain position.
`RandomFrom`	function	Choose a random string from an array of strings.
`RemoveLeadingChars`	procedure	Remove any leading characters in a set from a string.
`RemovePadChars`	procedure	Remove any trailing or leading characters in a set from a string.
`RemoveTrailingChars`	procedure	Remove any trailing characters in a set from a string.
`ReplaceStr`	function	Replace strings case-sensitively.
`ReplaceText`	function	Replace strings case-insensitively.
`ResemblesText`	function	Check whether 2 strings resemble each other.
`ReverseString`	function	Reverse characters in a string.
`RightBStr`	function	Copy a given number of characters (bytes), counting from the right of a string.
`RightStr`	function	Copy a given number of characters, counting from the right of a string.
`RomanToInt`	function	Convert a string with a Roman number to it's decimal value.
`RomanToIntDef`	function	Convert a roman numeral to an integer value.
`RPos`	function	Find last occurrence of substring or character in a string.
`RPosEx`	function	Find last occurrence substring or character in a string, starting at a certain position.
`SearchBuf`	function	Search a buffer for a certain string.
`SecureCompare`	function
`Soundex`	function	Compute the soundex of a string.
`SoundexCompare`	function	Compare soundex values of 2 strings.
`SoundexInt`	function	Soundex value as an integer.
`SoundexProc`	function	Default AnsiResemblesText implementation.
`SoundexSimilar`	function	Check whether 2 strings have equal soundex values.
`SoundexWord`	function	Calculate a word-sized soundex value.
`SplitCommandLine`	function	Split commandline in a series of separate arguments.
`SplitString`	function	Split a string in words.
`StartsStr`	function	Check whether one string starts with another.
`StartsText`	function	Check whether one text starts with another.
`StringReplace`	function	Optimized search-and-replace algorithm.
`StringsReplace`	function	Replace occurrences of a set of strings to another set of strings.
`StuffString`	function	Replace part of a string with another string.
`Tab2Space`	function	Convert tab characters to a number of spaces.
`TrimLeftSet`	function	Remove any leading characters in a set from a string and returns the result.
`TrimRightSet`	function	Remove any trailing characters in a set from a string and returns the result.
`TrimSet`	function	Remove any leading or trailing characters in a set from a string and returns the result.
`TryRomanToInt`	function	Try to convert a roman numeral to an integer value.
`WordCount`	function	Count the number of words in a string.
`WordPosition`	function	Search position of Nth word in a string.
`XorDecode`	function	Decode a string encoded with .
`XorEncode`	function	Encode a string by XOR-ing its characters using characters of a given key, representing the result as hex values.
`XorString`	function	Encode a string by XOR-ing its characters using characters of a given key.

Types

`SizeIntArray`	type	Array of SizeInt.
`TCompareTextProc`	procedure type	Function prototype for comparing two string in .
`TRawByteStringArray`	type	Array of RawByteString.
`TRomanConversionStrictness`	enumeration	How to treat invalid roman numerals in TryRomanToInt.
`TSoundexIntLength`	type	Range of allowed integer soundex lengths.
`TSoundexLength`	type	Range of allowed soundex lengths.
`TStringReplaceAlgorithm`	enumeration	Algorithm to use in StringReplace.
`TStringSeachOption`	type	Possible options for call.
`TStringSearchOption`	enumeration	Possible options for call.
`TStringSearchOptions`	set	Set of options for call.
`TUnicodeStringArray`	type

Constants

`AnsiResemblesProc`	constant	Procedural variable, called when checking 2 strings for resemblances in .
`Brackets`	constant	Set of characters that contain all possible bracket characters.
`DigitChars`	constant	Set of digit characters.
`ResemblesProc`	constant	Callback to compute string soundex.
`StdSwitchChars`	constant	Standard characters for the SwitchChars argument of .
`StdWordDelims`	constant	Standard word delimiter values.
`WordDelimiters`	constant	Standard word delimiters.

Resource strings

`SErrAmountStrings`	resource string	Error message used in stringsreplace function.
`SInvalidRomanNumeral`	resource string	Error string shown in exception raised when invalid roman numeral is encountered.

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.