Debian Codegraph @

upstream/debian-unstable/man3/Test2::Compare::Negatable.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Compare::Negatable 3perl"
58 .TH Test2::Compare::Negatable 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Compare::Negatable \- Poor mans 'role' for compare objects that can be negated.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Using this package inside an Test2::Compare::Base subclass will overload
68 \&\f(CW\*(C`!$obj\*(C'\fR and import \f(CWclone_negate()\fR and \f(CWtoggle_negate()\fR.
69 .SH WHY?
70 .IX Header "WHY?"
71 Until perl 5.18 the 'fallback' parameter to overload would not be inherited,
72 so we cannot use inheritance for the behavior we actually want. This module
73 works around the problem by emulating the \f(CW\*(C`use overload\*(C'\fR call we want for each
74 consumer class.
75 .SH ATTRIBUTES
76 .IX Header "ATTRIBUTES"
77 .ie n .IP "$bool = $obj\->negate" 4
78 .el .IP "\f(CW$bool\fR = \f(CW$obj\fR\->negate" 4
79 .IX Item "$bool = $obj->negate"
80 .PD 0
81 .ie n .IP $obj\->set_negate($bool) 4
82 .el .IP \f(CW$obj\fR\->set_negate($bool) 4
83 .IX Item "$obj->set_negate($bool)"
84 .ie n .IP "$attr = \fBNEGATE()\fR" 4
85 .el .IP "\f(CW$attr\fR = \fBNEGATE()\fR" 4
86 .IX Item "$attr = NEGATE()"
87 .PD
88 The NEGATE attribute will be added via Test2::Util::HashBase.
89 .SH METHODS
90 .IX Header "METHODS"
91 .ie n .IP "$clone = $obj\->\fBclone_negate()\fR" 4
92 .el .IP "\f(CW$clone\fR = \f(CW$obj\fR\->\fBclone_negate()\fR" 4
93 .IX Item "$clone = $obj->clone_negate()"
94 Create a shallow copy of the object, and call \f(CW\*(C`toggle_negate\*(C'\fR on it.
95 .ie n .IP $obj\->\fBtoggle_negate()\fR 4
96 .el .IP \f(CW$obj\fR\->\fBtoggle_negate()\fR 4
97 .IX Item "$obj->toggle_negate()"
98 Toggle the negate attribute. If the attribute was on it will now be off, if it
99 was off it will now be on.
100 .SH SOURCE
101 .IX Header "SOURCE"
102 The source code repository for Test2\-Suite can be found at
103 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
104 .SH MAINTAINERS
105 .IX Header "MAINTAINERS"
106 .IP "Chad Granum <[email protected]>" 4
107 .IX Item "Chad Granum <[email protected]>"
108 .SH AUTHORS
109 .IX Header "AUTHORS"
110 .PD 0
111 .IP "Chad Granum <[email protected]>" 4
112 .IX Item "Chad Granum <[email protected]>"
113 .PD
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2018 Chad Granum <[email protected]>.
117 .PP
118 This program is free software; you can redistribute it and/or
119 modify it under the same terms as Perl itself.
120 .PP
121 See \fIhttp://dev.perl.org/licenses/\fR