Debian Codegraph @

upstream/mageia-cauldron/man3pm/Tie::Hash::NamedCapture.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Tie::Hash::NamedCapture 3pm"
61 .TH Tie::Hash::NamedCapture 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Tie::Hash::NamedCapture \- Named regexp capture buffers
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& tie my %hash, "Tie::Hash::NamedCapture";
72 \& # %hash now behaves like %+
73 \&
74 \& tie my %hash, "Tie::Hash::NamedCapture", all => 1;
75 \& # %hash now access buffers from regexp in $qr like %\-
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This module is used to implement the special hashes \f(CW\*(C`%+\*(C'\fR and \f(CW\*(C`%\-\*(C'\fR, but it
80 can be used to tie other variables as you choose.
81 .PP
82 When the \f(CW\*(C`all\*(C'\fR parameter is provided, then the tied hash elements will be
83 array refs listing the contents of each capture buffer whose name is the
84 same as the associated hash key. If none of these buffers were involved in
85 the match, the contents of that array ref will be as many \f(CW\*(C`undef\*(C'\fR values
86 as there are capture buffers with that name. In other words, the tied hash
87 will behave as \f(CW\*(C`%\-\*(C'\fR.
88 .PP
89 When the \f(CW\*(C`all\*(C'\fR parameter is omitted or false, then the tied hash elements
90 will be the contents of the leftmost defined buffer with the name of the
91 associated hash key. In other words, the tied hash will behave as
92 \&\f(CW\*(C`%+\*(C'\fR.
93 .PP
94 The keys of \f(CW\*(C`%\-\*(C'\fR\-like hashes correspond to all buffer names found in the
95 regular expression; the keys of \f(CW\*(C`%+\*(C'\fR\-like hashes list only the names of
96 buffers that have captured (and that are thus associated to defined values).
97 .PP
98 This implementation has been moved into the core executable, but you
99 can still load this module for backward compatibility.
100 .SH "SEE ALSO"
101 .IX Header "SEE ALSO"
102 perlreapi, re, "Pragmatic Modules" in perlmodlib, "%+" in perlvar,
103 "%\-" in perlvar.