_________________________________________________________________
::textutil - Procedures to manipulate texts and strings..
package require Tcl 8.2
package require textutil ?0.4?
textutil::adjust string args
textutil::splitx string {regexp [\t \r\n]+}
textutil::tabify string {num 8}
textutil::tabify2 string {num 8}
textutil::trim string {regexp [ \t]+}
textutil::trimleft string {regexp [ \t]+}
textutil::trimright string {regexp [ \t]+}
textutil::untabify string {num 8}
textutil::untabify2 string {num 8}
textutil::strRepeat string num
_________________________________________________________________
The ::textutil package provides commands that manipulate strings or texts (a.k.a. long strings or string with embedded newlines or paragraphs).
The complete set of procedures is described below.
textutil::adjust string args
Do a justification on the string according to args.
The string is taken as one big paragraph, ignoring
any newlines. Then the line is formatted according
to the options used, and the command return a new
string with enough lines to contain all the printable
chars in the input string. A line is a set of
chars between the beginning of the string and a
newline, or between 2 newlines, or between a newline
and the end of the string. If the input string
is small enough, the returned string won't contain
any newlines.
By default, any occurrence of spaces characters or tabulation are replaced by a single space so each word in a line is separated from the next one by exactly one space char, and this forms a real line. Each real line is placed in a logical line, which have exactly a given length (see -length option below). The real line may have a lesser length. Again by default, any trailing spaces are ignored before returning the string (see -full option below). The following options may be used after the string parameter, and change the way the command place a real line in a logical line.
center the real line is centered in the logical line. If needed, a set of space char are added at the beginning (half of the needed set) and at the end (half of the needed set) of the line if required (see -full option).
plain the real line is exactly set in the logical line. It means that there are no leading or trailing space chars. All the needed space chars are added in the real line, between 2 (or more) words.
right the real line is set on the right of the logical line. It means that there are no space chars at the end of this line, and there may be some space chars at the beginning, despite of the -full option.
textutil::splitx string {regexp [\t \r\n]+} Split the string and return a list. The string is split according to the regular expression regexp instead of a simple list of chars. Note that if you add parenthesis into the regexp, the parentheses part of separator would be added into list as additional element. If the string is empty the result is the empty list, like for split. If regexp is empty the string is split at every character, like split does.
textutil::tabify string {num 8}
Tabify the string by replacing any substring of num
space chars by a tabulation and return the result
as a new string.
textutil::tabify2 string {num 8}
Similar to textutil::tabify this command tabifies
the string and returns the result as a new string.
A different algorithm is used however. Instead of
replacing any substring of num spaces this comand
works more like an editor.
Each line of the text in string is treated as if there are tabstops every num columns. Only sequences of space characters containing more than one space character and found immediately before a tabstop are replaced with tabs.
textutil::trim string {regexp [ \t]+}
Remove in string any leading and trailing substring
according to the regular expression regexp and
return the result as a new string. This apply on
any line in the string, that is any substring
between 2 newline chars, or between the beginning
of the string and a newline, or between a newline
and the end of the string, or, if the string contain
no newline, between the beginning and the end
of the string.
textutil::trimleft string {regexp [ \t]+} Remove in string any leading substring according to the regular expression regexp and return the result as a new string. This apply on any line in the string, that is any substring between 2 newline chars, or between the beginning of the string and a newline, or between a newline and the end of the string, or, if the string contain no newline, between the beginning and the end of the string.
textutil::trimright string {regexp [ \t]+} Remove in string any trailing substring according to the regular expression regexp and return the result as a new string. This apply on any line in the string, that is any substring between 2 newline chars, or between the beginning of the string and a newline, or between a newline and the end of the string, or, if the string contain no newline, between the beginning and the end of the string.
textutil::untabify string {num 8}
Untabify the string by replacing any tabulation
char by a substring of num space chars and return
the result as a new string.
textutil::untabify2 string {num 8}
Untabify the string by replacing any tabulation char by a substring of at most num space chars and return the result as a new string. Unlike textutil::untabify each tab is not replaced by a fixed number of space characters. The command overlays each line in the string with tabstops every num columns instead and replaces tabs with just enough space characters to reach the next tabstop. This is the complement of the actions taken by textutil::tabify2.
There is one asymmetry though: A tab can be replaced with a single space, but not the other way around.
textutil::strRepeat text num
The implementation depends on the core executing
the package. Used string repeat if it is present,
or a fast tcl implementation if it is not. Returns
a string containing the text repeated num times.
The repetitions are joined without characters
between them. A value of num <= 0 causes the command
to return an empty string.
regexp, split, string
string, regular expression