textutil::split(3tText and string utilities, macro procestextutil::split(3tcl)
______________________________________________________________________________
NAME
textutil::split - Procedures to split texts
SYNOPSIS
package require Tcl 8.2
package require textutil::split ?0.8?
::textutil::split::splitn string ?len?
::textutil::split::splitx string ?regexp?
______________________________________________________________________________
DESCRIPTION
The package textutil::split provides commands that split strings by
size and arbitrary regular expressions.
The complete set of procedures is described below.
::textutil::split::splitn string ?len?
This command splits the given string into chunks of len charac-
ters and returns a list containing these chunks. The argument
len defaults to 1 if none is specified. A negative length is not
allowed and will cause the command to throw an error. Providing
an empty string as input is allowed, the command will then re-
turn an empty list. If the length of the string is not an entire
multiple of the chunk length, then the last chunk in the gener-
ated list will be shorter than len.
::textutil::split::splitx string ?regexp?
This command splits the string and return a list. The string is
split according to the regular expression regexp instead of a
simple list of chars. Note: When parentheses are used in the
regexp, i.e. regex capture groups, then these groups will be
added into the result list as additional elements. If the string
is empty the result is the empty list, like for split. If reg-
exp is empty the string is split at every character, like split
does. The regular expression regexp defaults to "[\\t
\\r\\n]+".
BUGS, IDEAS, FEEDBACK
This document, and the package it describes, will undoubtedly contain
bugs and other problems. Please report such in the category textutil
of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
also report any ideas for enhancements you may have for either package
and/or documentation.
When proposing code changes, please provide unified diffs, i.e the out-
put of diff -u.
Note further that attachments are strongly preferred over inlined
patches. Attachments can be made by going to the Edit form of the
ticket immediately after its creation, and then using the left-most
button in the secondary navigation bar.
SEE ALSO
regexp(3tcl), split(3tcl), string(3tcl)
KEYWORDS
regular expression, split, string
CATEGORY
Text processing
tcllib 0.8 textutil::split(3tcl)