1package Hints_pod_examples;
2use strict;
3use warnings;
4
5use Exporter 5.57 'import';
6
7our %DOES = ( 'autodie::hints::provider' => 1 );
8
9our @EXPORT_OK = qw(
10	undef_scalar false_scalar zero_scalar empty_list default_list
11	empty_or_false_list undef_n_error_list foo re_fail bar
12	think_positive my_system bizarro_system
13);
14
15use autodie::hints;
16
17sub AUTODIE_HINTS {
18    return {
19        # Scalar failures always return undef:
20        undef_scalar =>    {  fail => sub { !defined($_[0]) }  },
21
22        # Scalar failures return any false value [default behaviour]:
23        false_scalar =>    {  fail => sub { return ! $_[0] }  },
24
25        # Scalar failures always return zero explicitly:
26        zero_scalar =>     {  fail => sub { defined($_[0]) && $_[0] eq '0' }  },
27
28        # List failures always return empty list:
29        # We never want these called in a scalar context
30        empty_list  =>     {  scalar => sub { 1 }, list => sub { !@_ }  },
31
32        # List failures return C<()> or C<(undef)> [default expectation]:
33        default_list => {  fail => sub { ! @_ || @_ == 1 && !defined $_[0] }  },
34
35        # List failures return C<()> or a single false value:
36        empty_or_false_list => {  fail => sub { ! @_ || @_ == 1 && !$_[0] }  },
37
38        # List failures return (undef, "some string")
39        undef_n_error_list => {  fail => sub { @_ == 2 && !defined $_[0] }  },
40    };
41}
42
43# Define some subs that all just return their arguments
44sub undef_scalar { return wantarray ? @_ : $_[0] }
45sub false_scalar { return wantarray ? @_ : $_[0] }
46sub zero_scalar  { return wantarray ? @_ : $_[0] }
47sub empty_list   { return wantarray ? @_ : $_[0] }
48sub default_list { return wantarray ? @_ : $_[0] }
49sub empty_or_false_list { return wantarray ? @_ : $_[0] }
50sub undef_n_error_list { return wantarray ? @_  : $_[0] }
51
52
53# Unsuccessful foo() returns 0 in all contexts...
54autodie::hints->set_hints_for(
55    \&foo,
56    {
57	scalar => sub { defined($_[0]) && $_[0] == 0 },
58	list   => sub { @_ == 1 && defined($_[0]) && $_[0] == 0 },
59    }
60);
61
62sub foo { return wantarray ? @_ : $_[0] }
63
64# Unsuccessful re_fail() returns 'FAIL' or '_FAIL' in scalar context,
65#                    returns (-1) in list context...
66autodie::hints->set_hints_for(
67    \&re_fail,
68    {
69	scalar => qr/^ _? FAIL $/xms,
70	list   => sub { @_ == 1 && $_[0] eq -1 },
71    }
72);
73
74sub re_fail { return wantarray ? @_ : $_[0] }
75
76# Unsuccessful bar() returns 0 in all contexts...
77autodie::hints->set_hints_for(
78    \&bar,
79    {
80	scalar => sub { defined($_[0]) && $_[0] == 0 },
81	list   => sub { @_ == 1 && defined($_[0]) && $_[0] == 0 },
82    }
83);
84
85sub bar { return wantarray ? @_ : $_[0] }
86
87# Unsuccessful think_positive() returns negative number on failure...
88autodie::hints->set_hints_for(
89    \&think_positive,
90    {
91	scalar => sub { $_[0] < 0 },
92	list   => sub { $_[0] < 0 },
93    }
94);
95
96sub think_positive { return wantarray ? @_ : $_[0] }
97
98# Unsuccessful my_system() returns non-zero on failure...
99autodie::hints->set_hints_for(
100    \&my_system,
101    {
102	scalar => sub { $_[0] != 0 },
103	list   => sub { $_[0] != 0 },
104    }
105);
106sub my_system { return wantarray ? @_ : $_[0] };
107
1081;
109