1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
[manpage_begin textutil::trim n 0.7]
[see_also regexp(n)]
[see_also split(n)]
[see_also string(n)]
[keywords prefix]
[keywords {regular expression}]
[keywords string]
[keywords trimming]
[moddesc {Text and string utilities, macro processing}]
[titledesc {Procedures to trim strings}]
[category {Text processing}]
[require Tcl 8.2]
[require textutil::trim [opt 0.7]]
[description]
The package [package textutil::trim] provides commands that trim
strings using arbitrary regular expressions.
[para]
The complete set of procedures is described below.
[list_begin definitions]
[call [cmd ::textutil::trim::trim] [arg string] [opt [arg regexp]]]
Remove in [arg string] any leading and trailing substring according to
the regular expression [arg regexp] and return the result as a new
string. This is done for all [emph lines] 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.
The regular expression [arg regexp] defaults to "[lb] \\t[rb]+".
[call [cmd ::textutil::trim::trimleft] [arg string] [opt [arg regexp]]]
Remove in [arg string] any leading substring according to the regular
expression [arg regexp] and return the result as a new string. This
apply on any [emph 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.
The regular expression [arg regexp] defaults to "[lb] \\t[rb]+".
[call [cmd ::textutil::trim::trimright] [arg string] [opt [arg regexp]]]
Remove in [arg string] any trailing substring according to the regular
expression [arg regexp] and return the result as a new string. This
apply on any [emph 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.
The regular expression [arg regexp] defaults to "[lb] \\t[rb]+".
[call [cmd ::textutil::trim::trimPrefix] [arg string] [arg prefix]]
Removes the [arg prefix] from the beginning of [arg string] and
returns the result. The [arg string] is left unchanged if it doesn't
have [arg prefix] at its beginning.
[call [cmd ::textutil::trim::trimEmptyHeading] [arg string]]
Looks for empty lines (including lines consisting of only whitespace)
at the beginning of the [arg string] and removes it. The modified
string is returned as the result of the command.
[list_end]
[vset CATEGORY textutil]
[include ../common-text/feedback.inc]
[manpage_end]
|
