This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix a syntax error in test
[perl5.git] / lib / Text / Balanced / README
CommitLineData
55a1c97c 1==============================================================================
48f821bf 2 Release of version 1.95 of Text::Balanced
55a1c97c
JH
3==============================================================================
4
5
6NAME
7
8 Text::Balanced - Extract delimited text sequences from strings.
9
10
11SUMMARY (see Balanced.pod for full details)
12
13 Text::Balanced::extract_delimited
14
15 `extract_delimited' extracts the initial substring of a string
16 which is delimited by a user-specified set of single-character
17 delimiters, whilst ignoring any backslash-escaped delimiter
18 characters.
19
20 Text::Balanced::extract_bracketed
21
22 `extract_bracketed' extracts a balanced-bracket-delimited substring
23 (using any one (or more) of the user-specified delimiter brackets:
24 '(..)', '{..}', '[..]', or '<..>').
25
26 Text::Balanced::extract_quotelike
27
28 `extract_quotelike' attempts to recognize and extract any one of the
29 various Perl quote and quotelike operators (see "perlop(3)"). Embedded
30 backslashed delimiters, nested bracket delimiters (for the
31 quotelike operators), and trailing modifiers are all correctly handled.
32
33 Text::Balanced::extract_codeblock
34
35 `extract_codeblock' attempts to recognize and extract a
36 balanced bracket-delimited substring which may also contain
37 unbalanced brackets inside Perl quotes or quotelike
38 operations. That is, `extract_codeblock' is like a combination
39 of `extract_bracketed' and `extract_quotelike'.
40
41 Text::Balanced::extract_tagged
42
43 `extract_tagged' attempts to recognize and extract a
44 substring between two arbitrary "tag" patterns (a start tag
45 and an end tag).
46
47
48INSTALLATION
49
50 It's all pure Perl, so just put the .pm file in its appropriate
51 local Perl subdirectory.
52
53
54AUTHOR
55
56 Damian Conway (damian@cs.monash.edu.au)
57
58
59COPYRIGHT
60
61 Copyright (c) 1997-2001, Damian Conway. All Rights Reserved.
62 This module is free software. It may be used, redistributed
63 and/or modified under the same terms as Perl itself.
64
65
66
67==============================================================================
68
48f821bf 69CHANGES IN VERSION 1.95
55a1c97c
JH
70
71
48f821bf
JH
72 - Constrainted _match_quote to only match at word boundaries
73 (so "exemplum(hic)" doesn't match "m(hic)")
74 (thanks Craig)
55a1c97c
JH
75
76
77==============================================================================
78
79AVAILABILITY
80
81Text::Balanced has been uploaded to the CPAN
55a1c97c
JH
82
83==============================================================================