Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Compare::Negatable.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 "Test2::Compare::Negatable 3pm"
61 .TH Test2::Compare::Negatable 3pm 2026-03-09 "perl v5.42.1" "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 Test2::Compare::Negatable \- Poor mans \*(Aqrole\*(Aq for compare objects that can be negated.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Using this package inside an Test2::Compare::Base subclass will overload
71 \&\f(CW\*(C`!$obj\*(C'\fR and import \f(CWclone_negate()\fR and \f(CWtoggle_negate()\fR.
72 .SH WHY?
73 .IX Header "WHY?"
74 Until perl 5.18 the \*(Aqfallback\*(Aq parameter to overload would not be inherited,
75 so we cannot use inheritance for the behavior we actually want. This module
76 works around the problem by emulating the \f(CW\*(C`use overload\*(C'\fR call we want for each
77 consumer class.
78 .SH ATTRIBUTES
79 .IX Header "ATTRIBUTES"
80 .ie n .IP "$bool = $obj\->negate" 4
81 .el .IP "\f(CW$bool\fR = \f(CW$obj\fR\->negate" 4
82 .IX Item "$bool = $obj->negate"
83 .PD 0
84 .ie n .IP $obj\->set_negate($bool) 4
85 .el .IP \f(CW$obj\fR\->set_negate($bool) 4
86 .IX Item "$obj->set_negate($bool)"
87 .ie n .IP "$attr = \fBNEGATE()\fR" 4
88 .el .IP "\f(CW$attr\fR = \fBNEGATE()\fR" 4
89 .IX Item "$attr = NEGATE()"
90 .PD
91 The NEGATE attribute will be added via Test2::Util::HashBase.
92 .SH METHODS
93 .IX Header "METHODS"
94 .ie n .IP "$clone = $obj\->\fBclone_negate()\fR" 4
95 .el .IP "\f(CW$clone\fR = \f(CW$obj\fR\->\fBclone_negate()\fR" 4
96 .IX Item "$clone = $obj->clone_negate()"
97 Create a shallow copy of the object, and call \f(CW\*(C`toggle_negate\*(C'\fR on it.
98 .ie n .IP $obj\->\fBtoggle_negate()\fR 4
99 .el .IP \f(CW$obj\fR\->\fBtoggle_negate()\fR 4
100 .IX Item "$obj->toggle_negate()"
101 Toggle the negate attribute. If the attribute was on it will now be off, if it
102 was off it will now be on.
103 .SH SOURCE
104 .IX Header "SOURCE"
105 The source code repository for Test2\-Suite can be found at
106 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
107 .SH MAINTAINERS
108 .IX Header "MAINTAINERS"
109 .IP "Chad Granum <[email protected]>" 4
110 .IX Item "Chad Granum <[email protected]>"
111 .SH AUTHORS
112 .IX Header "AUTHORS"
113 .IP "Chad Granum <[email protected]>" 4
114 .IX Item "Chad Granum <[email protected]>"
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright Chad Granum <[email protected]>.
118 .PP
119 This program is free software; you can redistribute it and/or
120 modify it under the same terms as Perl itself.
121 .PP
122 See \fIhttp://dev.perl.org/licenses/\fR