t/op/tie_fetch_count.t

   1 #!./perl
   2 # Tests counting number of FETCHes.
   3 #
   4 # See Bugs #76814 and #87708.
   5
   6 BEGIN {
   7     chdir 't' if -d 't';
   8     @INC = '../lib';
   9     require './test.pl';
  10     plan (tests => 218);
  11 }
  12
  13 use strict;
  14 use warnings;
  15
  16 my $count = 0;
  17
  18 # Usage:
  19 #   tie $var, "main", $val;          # FETCH returns $val
  20 #   tie $var, "main", $val1, $val2;  # FETCH returns the values in order,
  21 #                                    # one at a time, repeating the last
  22 #                                    # when the list is exhausted.
  23 sub TIESCALAR {my $pack = shift; bless [@_], $pack;}
  24 sub FETCH {$count ++; @{$_ [0]} == 1 ? ${$_ [0]}[0] : shift @{$_ [0]}}
  25 sub STORE { unshift @{$_[0]}, $_[1] }
  26
  27
  28 sub check_count {
  29     my $op = shift;
  30     my $expected = shift() // 1;
  31     is $count, $expected,
  32         "FETCH called " . (
  33           $expected == 1 ? "just once" :
  34           $expected == 2 ? "twice"     :
  35                            "$count times"
  36         ) . " using '$op'";
  37     $count = 0;
  38 }
  39
  40 my ($dummy, @dummy);
  41
  42 tie my $var => 'main', 1;
  43
  44 # Assignment.
  45 $dummy  =  $var         ; check_count "=";
  46
  47 # Unary +/-
  48 $dummy  = +$var         ; check_count "unary +";
  49 $dummy  = -$var         ; check_count "unary -";
  50
  51 # Basic arithmetic and string operators.
  52 $dummy  =  $var   +   1 ; check_count '+';
  53 $dummy  =  $var   -   1 ; check_count '-';
  54 $dummy  =  $var   /   1 ; check_count '/';
  55 $dummy  =  $var   *   1 ; check_count '*';
  56 $dummy  =  $var   %   1 ; check_count '%';
  57 $dummy  =  $var  **   1 ; check_count '**';
  58 $dummy  =  $var  <<   1 ; check_count '<<';
  59 $dummy  =  $var  >>   1 ; check_count '>>';
  60 $dummy  =  $var   x   1 ; check_count 'x';
  61 @dummy  = ($var)  x   1 ; check_count 'x';
  62 $dummy  =  $var   .   1 ; check_count '.';
  63
  64 # Pre/post in/decrement
  65            $var ++      ; check_count 'post ++';
  66            $var --      ; check_count 'post --';
  67         ++ $var         ; check_count 'pre ++';
  68         -- $var         ; check_count 'pre --';
  69
  70 # Numeric comparison
  71 $dummy  =  $var  <    1 ; check_count '<';
  72 $dummy  =  $var  <=   1 ; check_count '<=';
  73 $dummy  =  $var  ==   1 ; check_count '==';
  74 $dummy  =  $var  >=   1 ; check_count '>=';
  75 $dummy  =  $var  >    1 ; check_count '>';
  76 $dummy  =  $var  !=   1 ; check_count '!=';
  77 $dummy  =  $var <=>   1 ; check_count '<=>';
  78
  79 # String comparison
  80 $dummy  =  $var  lt   1 ; check_count 'lt';
  81 $dummy  =  $var  le   1 ; check_count 'le';
  82 $dummy  =  $var  eq   1 ; check_count 'eq';
  83 $dummy  =  $var  ge   1 ; check_count 'ge';
  84 $dummy  =  $var  gt   1 ; check_count 'gt';
  85 $dummy  =  $var  ne   1 ; check_count 'ne';
  86 $dummy  =  $var cmp   1 ; check_count 'cmp';
  87
  88 # Bitwise operators
  89 $dummy  =  $var   &   1 ; check_count '&';
  90 $dummy  =  $var   ^   1 ; check_count '^';
  91 $dummy  =  $var   |   1 ; check_count '|';
  92 $dummy  = ~$var         ; check_count '~';
  93
  94 # Logical operators
  95 $dummy  = !$var         ; check_count '!';
  96 tie my $v_1, "main", 0;
  97 $dummy  =  $v_1  ||   1 ; check_count '||';
  98 $dummy  = ($v_1  or   1); check_count 'or';
  99 $dummy  =  $var  &&   1 ; check_count '&&';
 100 $dummy  = ($var and   1); check_count 'and';
 101 $dummy  = ($var xor   1); check_count 'xor';
 102 $dummy  =  $var ? 1 : 1 ; check_count '?:';
 103
 104 # Overloadable functions
 105 $dummy  =   sin $var    ; check_count 'sin';
 106 $dummy  =   cos $var    ; check_count 'cos';
 107 $dummy  =   exp $var    ; check_count 'exp';
 108 $dummy  =   abs $var    ; check_count 'abs';
 109 $dummy  =   log $var    ; check_count 'log';
 110 $dummy  =  sqrt $var    ; check_count 'sqrt';
 111 $dummy  =   int $var    ; check_count 'int';
 112 $dummy  = atan2 $var, 1 ; check_count 'atan2';
 113
 114 # Readline/glob
 115 tie my $var0, "main", \*DATA;
 116 $dummy  = <$var0>       ; check_count '<readline>';
 117 $dummy  = <${var}>      ; check_count '<glob>';
 118
 119 # File operators
 120 $dummy  = -r $var       ; check_count '-r';
 121 $dummy  = -w $var       ; check_count '-w';
 122 $dummy  = -x $var       ; check_count '-x';
 123 $dummy  = -o $var       ; check_count '-o';
 124 $dummy  = -R $var       ; check_count '-R';
 125 $dummy  = -W $var       ; check_count '-W';
 126 $dummy  = -X $var       ; check_count '-X';
 127 $dummy  = -O $var       ; check_count '-O';
 128 $dummy  = -e $var       ; check_count '-e';
 129 $dummy  = -z $var       ; check_count '-z';
 130 $dummy  = -s $var       ; check_count '-s';
 131 $dummy  = -f $var       ; check_count '-f';
 132 $dummy  = -d $var       ; check_count '-d';
 133 $dummy  = -l $var       ; check_count '-l';
 134 $dummy  = -p $var       ; check_count '-p';
 135 $dummy  = -S $var       ; check_count '-S';
 136 $dummy  = -b $var       ; check_count '-b';
 137 $dummy  = -c $var       ; check_count '-c';
 138 $dummy  = -t $var       ; check_count '-t';
 139 $dummy  = -u $var       ; check_count '-u';
 140 $dummy  = -g $var       ; check_count '-g';
 141 $dummy  = -k $var       ; check_count '-k';
 142 $dummy  = -T $var       ; check_count '-T';
 143 $dummy  = -B $var       ; check_count '-B';
 144 $dummy  = -M $var       ; check_count '-M';
 145 $dummy  = -A $var       ; check_count '-A';
 146 $dummy  = -C $var       ; check_count '-C';
 147
 148 # Matching
 149 $_ = "foo";
 150 $dummy  =  $var =~ m/ / ; check_count 'm//';
 151 $dummy  =  $var =~ s/ //; check_count 's///';
 152 $dummy  =  $var ~~    1 ; check_count '~~';
 153 $dummy  =  $var =~ y/ //; check_count 'y///';
 154            /$var/       ; check_count 'm/pattern/';
 155            /$var foo/   ; check_count 'm/$tied foo/';
 156           s/$var//      ; check_count 's/pattern//';
 157           s/$var foo//  ; check_count 's/$tied foo//';
 158           s/./$var/     ; check_count 's//replacement/';
 159
 160 # Dereferencing
 161 tie my $var1 => 'main', \1;
 162 $dummy  = $$var1        ; check_count '${}';
 163 tie my $var2 => 'main', [];
 164 $dummy  = @$var2        ; check_count '@{}';
 165 $dummy  = shift $var2   ; check_count 'shift arrayref';
 166 tie my $var3 => 'main', {};
 167 $dummy  = %$var3        ; check_count '%{}';
 168 $dummy  = keys $var3    ; check_count 'keys hashref';
 169 {
 170     no strict 'refs';
 171     tie my $var4 => 'main', **;
 172     $dummy  = *$var4        ; check_count '*{}';
 173 }
 174
 175 tie my $var5 => 'main', sub {1};
 176 $dummy  = &$var5        ; check_count '&{}';
 177
 178 {
 179     no strict 'refs';
 180     tie my $var1 => 'main', 1;
 181     $dummy  = $$var1        ; check_count 'symbolic ${}';
 182     $dummy  = @$var1        ; check_count 'symbolic @{}';
 183     $dummy  = %$var1        ; check_count 'symbolic %{}';
 184     $dummy  = *$var1        ; check_count 'symbolic *{}';
 185     local *1 = sub{};
 186     $dummy  = &$var1        ; check_count 'symbolic &{}';
 187
 188     # This test will not be a complete test if ${^OPEN} has been created
 189     # already.  If this dies, change it to use another built-in variable.
 190     # In 5.10-14, rv2gv calls get-magic more times for built-in vars, which
 191     # is why we need the test this way.
 192     if (exists $::{"\cOPEN"}) {
 193         die "*{^OPEN} already exists. Please adjust this test"
 194     }
 195     tie my $var6 => main => "\cOPEN";
 196     no warnings;
 197     readdir $var6           ; check_count 'symbolic readdir';
 198     if (exists $::{973}) { # Need a different variable here
 199         die "*973 already exists. Please adjust this test"
 200     }
 201     tie my $var7 => main => 973;
 202     defined $$var7          ; check_count 'symbolic defined ${}';
 203 }
 204
 205 tie my $var8 => 'main', 'main';
 206 sub bolgy {}
 207 $var8->bolgy            ; check_count '->method';
 208
 209 ###############################################
 210 #        Tests for  $foo binop $foo           #
 211 ###############################################
 212
 213 # These test that binary ops call FETCH twice if the same scalar is used
 214 # for both operands. They also test that both return values from
 215 # FETCH are used.
 216
 217 my %mutators = map { ($_ => 1) } qw(. + - * / % ** << >> & | ^);
 218
 219
 220 sub _bin_test {
 221     my $int = shift;
 222     my $op = shift;
 223     my $exp = pop;
 224     my @fetches = @_;
 225
 226     $int = $int ? 'use integer; ' : '';
 227
 228     tie my $var, "main", @fetches;
 229     is(eval "$int\$var $op \$var", $exp, "retval of $int\$var $op \$var");
 230     check_count "$int$op", 2;
 231
 232     return unless $mutators{$op};
 233
 234     tie my $var2, "main", @fetches;
 235     is(eval "$int \$var2 $op= \$var2", $exp, "retval of $int \$var2 $op= \$var2");
 236     check_count "$int$op=", 3;
 237 }
 238
 239 sub bin_test {
 240     _bin_test(0, @_);
 241 }
 242
 243 sub bin_int_test {
 244     _bin_test(1, @_);
 245 }
 246
 247 bin_test '**',  2, 3, 8;
 248 bin_test '*' ,  2, 3, 6;
 249 bin_test '/' , 10, 2, 5;
 250 bin_test '%' , 11, 2, 1;
 251 bin_test 'x' , 11, 2, 1111;
 252 bin_test '-' , 11, 2, 9;
 253 bin_test '<<', 11, 2, 44;
 254 bin_test '>>', 44, 2, 11;
 255 bin_test '<' ,  1, 2, 1;
 256 bin_test '>' , 44, 2, 1;
 257 bin_test '<=', 44, 2, "";
 258 bin_test '>=',  1, 2, "";
 259 bin_test '!=',  1, 2, 1;
 260 bin_test '<=>', 1, 2, -1;
 261 bin_test 'le',  4, 2, "";
 262 bin_test 'lt',  1, 2, 1;
 263 bin_test 'gt',  4, 2, 1;
 264 bin_test 'ge',  1, 2, "";
 265 bin_test 'eq',  1, 2, "";
 266 bin_test 'ne',  1, 2, 1;
 267 bin_test 'cmp', 1, 2, -1;
 268 bin_test '&' ,  1, 2, 0;
 269 bin_test '|' ,  1, 2, 3;
 270 bin_test '^' ,  3, 5, 6;
 271 bin_test '.' ,  1, 2, 12;
 272 bin_test '==',  1, 2, "";
 273 bin_test '+' ,  1, 2, 3;
 274 bin_int_test '*' ,  2, 3, 6;
 275 bin_int_test '/' , 10, 2, 5;
 276 bin_int_test '%' , 11, 2, 1;
 277 bin_int_test '+' ,  1, 2, 3;
 278 bin_int_test '-' , 11, 2, 9;
 279 bin_int_test '<' ,  1, 2, 1;
 280 bin_int_test '>' , 44, 2, 1;
 281 bin_int_test '<=', 44, 2, "";
 282 bin_int_test '>=',  1, 2, "";
 283 bin_int_test '==',  1, 2, "";
 284 bin_int_test '!=',  1, 2, 1;
 285 bin_int_test '<=>', 1, 2, -1;
 286 tie $var, "main", 1, 4;
 287 cmp_ok(atan2($var, $var), '<', .3, 'retval of atan2 $var, $var');
 288 check_count 'atan2',  2;
 289
 290 __DATA__