[p5sagit/p5-mst-13.2.git] / ext / XS / APItest / t / hash.t

#!perl -w

BEGIN {
  chdir 't' if -d 't';
  @INC = '../lib';
  push @INC, "::lib:$MacPerl::Architecture:" if $^O eq 'MacOS';
  require Config; import Config;
  if ($Config{'extensions'} !~ /\bXS\/APItest\b/) {
    # Look, I'm using this fully-qualified variable more than once!
    my $arch = $MacPerl::Architecture;
    print "1..0 # Skip: XS::APItest was not built\n";
    exit 0;
  }
}

use strict;
use utf8;
use Tie::Hash;
use Test::More 'no_plan';

BEGIN {use_ok('XS::APItest')};

sub preform_test;
sub test_present;
sub test_absent;
sub test_delete_present;
sub test_delete_absent;
sub brute_force_exists;
sub test_store;
sub test_fetch_present;
sub test_fetch_absent;

my $utf8_for_258 = chr 258;
utf8::encode $utf8_for_258;

my @testkeys = ('N', chr 198, chr 256);
my @keys = (@testkeys, $utf8_for_258);

foreach (@keys) {
  utf8::downgrade $_, 1;
}
main_tests (\@keys, \@testkeys, '');

foreach (@keys) {
  utf8::upgrade $_;
}
main_tests (\@keys, \@testkeys, ' [utf8 hash]');

{
  my %h = (a=>'cheat');
  tie %h, 'Tie::StdHash';
  # is bug 36327 fixed?
  my $result = ($] > 5.009) ? undef : 1;

  is (XS::APItest::Hash::store(\%h, chr 258,  1), $result);
    
  ok (!exists $h{$utf8_for_258},
      "hv_store doesn't insert a key with the raw utf8 on a tied hash");
}

if ($] > 5.009) {
    my $strtab = strtab();
    is (ref $strtab, 'HASH', "The shared string table quacks like a hash");
    my $wibble = "\0";
    eval {
	$strtab->{$wibble}++;
    };
    my $prefix = "Cannot modify shared string table in hv_";
    my $what = $prefix . 'fetch';
    like ($@, qr/^$what/,$what);
    eval {
	XS::APItest::Hash::store($strtab, 'Boom!',  1)
    };
    $what = $prefix . 'store';
    like ($@, qr/^$what/, $what);
    if (0) {
	A::B->method();
    }
    # DESTROY should be in there.
    eval {
	delete $strtab->{DESTROY};
    };
    $what = $prefix . 'delete';
    like ($@, qr/^$what/, $what);
    # I can't work out how to get to the code that flips the wasutf8 flag on
    # the hash key without some ikcy XS
}

{
    is_deeply([&XS::APItest::Hash::test_hv_free_ent], [2,2,1,1],
	      "hv_free_ent frees the value immediately");
    is_deeply([&XS::APItest::Hash::test_hv_delayfree_ent], [2,2,2,1],
	      "hv_delayfree_ent keeps the value around until FREETMPS");
}

foreach my $in ("", "N", "a\0b") {
    my $got = XS::APItest::Hash::test_share_unshare_pvn($in);
    is ($got, $in, "test_share_unshare_pvn");
}

if ($] > 5.009) {
    foreach ([\&XS::APItest::Hash::rot13_hash, \&rot13, "rot 13"],
	     [\&XS::APItest::Hash::bitflip_hash, \&bitflip, "bitflip"],
	    ) {
	my ($setup, $mapping, $name) = @$_;
	my %hash;
	my %placebo = (a => 1, p => 2, i => 4, e => 8);
	$setup->(\%hash);
	$hash{a}++; @hash{qw(p i e)} = (2, 4, 8);

	test_U_hash(\%hash, \%placebo, [f => 9, g => 10, h => 11], $mapping,
		    $name);
    }
    foreach my $upgrade_o (0, 1) {
	foreach my $upgrade_n (0, 1) {
	    my (%hash, %placebo);
	    XS::APItest::Hash::bitflip_hash(\%hash);
	    foreach my $new (["7", 65, 67, 80],
			     ["8", 163, 171, 215],
			     ["U", 2603, 2604, 2604],
			    ) {
		foreach my $code (78, 240, 256, 1336) {
		    my $key = chr $code;
		    # This is the UTF-8 byte sequence for the key.
		    my $key_utf8 = $key;
		    utf8::encode($key_utf8);
		    if ($upgrade_o) {
			$key .= chr 256;
			chop $key;
		    }
		    $hash{$key} = $placebo{$key} = $code;
		    $hash{$key_utf8} = $placebo{$key_utf8} = "$code as UTF-8";
		}
		my $name = 'bitflip ' . shift @$new;
		my @new_kv;
		foreach my $code (@$new) {
		    my $key = chr $code;
		    if ($upgrade_n) {
			$key .= chr 256;
			chop $key;
		    }
		    push @new_kv, $key, $_;
		}

		$name .= ' upgraded(orig) ' if $upgrade_o;
		$name .= ' upgraded(new) ' if $upgrade_n;
		test_U_hash(\%hash, \%placebo, \@new_kv, \&bitflip, $name);
	    }
	}
    }
}

{
    my $as_utf8 = "\241" . chr 256;
    chop $as_utf8;
    my $as_bytes = "\243";
    foreach my $key ('N', $as_bytes, $as_utf8, "\x{2623}") {
	my $ord = ord $key;
	foreach my $hash_pv (0, 1) {
	    my %hash;
	    is (XS::APItest::Hash::common({hv => \%hash, keypv => $key,
					   val => $ord, hash_pv => $hash_pv,
					   action =>
					   XS::APItest::HV_FETCH_ISSTORE}),
		$ord, "store $ord \$hash_pv = $hash_pv");
	    is_deeply ([each %hash], [$key, $ord], "First key read is good");
	    is_deeply ([each %hash], [], "No second key good");

	    is ($hash{$key}, $ord, "Direct hash read finds $ord");
	}
    }
}

exit;

################################   The End   ################################

sub test_U_hash {
    my ($hash, $placebo, $new, $mapping, $message) = @_;
    my @hitlist = keys %$placebo;
    print "# $message\n";

    my @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))),
	"uvar magic called exactly once on store");

    is (keys %$hash, keys %$placebo);

    my $victim = shift @hitlist;
    is (delete $hash->{$victim}, delete $placebo->{$victim});

    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    $victim = shift @hitlist;
    is (XS::APItest::Hash::delete_ent ($hash, $victim,
				       XS::APItest::HV_DISABLE_UVAR_XKEY),
	undef, "Deleting a known key with conversion disabled fails (ent)");
    is (keys %$hash, keys %$placebo);

    is (XS::APItest::Hash::delete_ent ($hash, $victim, 0),
	delete $placebo->{$victim},
	"Deleting a known key with conversion enabled works (ent)");
    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    $victim = shift @hitlist;
    is (XS::APItest::Hash::delete ($hash, $victim,
				   XS::APItest::HV_DISABLE_UVAR_XKEY),
	undef, "Deleting a known key with conversion disabled fails");
    is (keys %$hash, keys %$placebo);

    is (XS::APItest::Hash::delete ($hash, $victim, 0),
	delete $placebo->{$victim},
	"Deleting a known key with conversion enabled works");
    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    my ($k, $v) = splice @$new, 0, 2;
    $hash->{$k} = $v;
    $placebo->{$k} = $v;
    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    ($k, $v) = splice @$new, 0, 2;
    is (XS::APItest::Hash::store_ent($hash, $k, $v), $v, "store_ent");
    $placebo->{$k} = $v;
    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    ($k, $v) = splice @$new, 0, 2;
    is (XS::APItest::Hash::store($hash, $k, $v), $v, "store");
    $placebo->{$k} = $v;
    is (keys %$hash, keys %$placebo);
    @keys = sort keys %$hash;
    is ("@keys", join(' ', sort($mapping->(keys %$placebo))));

    @hitlist = keys %$placebo;
    $victim = shift @hitlist;
    is (XS::APItest::Hash::fetch_ent($hash, $victim), $placebo->{$victim},
	"fetch_ent");
    is (XS::APItest::Hash::fetch_ent($hash, $mapping->($victim)), undef,
	"fetch_ent (missing)");

    $victim = shift @hitlist;
    is (XS::APItest::Hash::fetch($hash, $victim), $placebo->{$victim},
	"fetch");
    is (XS::APItest::Hash::fetch($hash, $mapping->($victim)), undef,
	"fetch (missing)");

    $victim = shift @hitlist;
    ok (XS::APItest::Hash::exists_ent($hash, $victim), "exists_ent");
    ok (!XS::APItest::Hash::exists_ent($hash, $mapping->($victim)),
	"exists_ent (missing)");

    $victim = shift @hitlist;
    die "Need a victim" unless defined $victim;
    ok (XS::APItest::Hash::exists($hash, $victim), "exists");
    ok (!XS::APItest::Hash::exists($hash, $mapping->($victim)),
	"exists (missing)");

    is (XS::APItest::Hash::common({hv => $hash, keysv => $victim}),
	$placebo->{$victim}, "common (fetch)");
    is (XS::APItest::Hash::common({hv => $hash, keypv => $victim}),
	$placebo->{$victim}, "common (fetch pv)");
    is (XS::APItest::Hash::common({hv => $hash, keysv => $victim,
				   action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	undef, "common (fetch) missing");
    is (XS::APItest::Hash::common({hv => $hash, keypv => $victim,
				   action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	undef, "common (fetch pv) missing");
    is (XS::APItest::Hash::common({hv => $hash, keysv => $mapping->($victim),
				   action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	$placebo->{$victim}, "common (fetch) missing mapped");
    is (XS::APItest::Hash::common({hv => $hash, keypv => $mapping->($victim),
				   action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	$placebo->{$victim}, "common (fetch pv) missing mapped");
}

sub main_tests {
  my ($keys, $testkeys, $description) = @_;
  foreach my $key (@$testkeys) {
    my $lckey = ($key eq chr 198) ? chr 230 : lc $key;
    my $unikey = $key;
    utf8::encode $unikey;

    utf8::downgrade $key, 1;
    utf8::downgrade $lckey, 1;
    utf8::downgrade $unikey, 1;
    main_test_inner ($key, $lckey, $unikey, $keys, $description);

    utf8::upgrade $key;
    utf8::upgrade $lckey;
    utf8::upgrade $unikey;
    main_test_inner ($key, $lckey, $unikey, $keys,
		     $description . ' [key utf8 on]');
  }

  # hv_exists was buggy for tied hashes, in that the raw utf8 key was being
  # used - the utf8 flag was being lost.
  perform_test (\&test_absent, (chr 258), $keys, '');

  perform_test (\&test_fetch_absent, (chr 258), $keys, '');
  perform_test (\&test_delete_absent, (chr 258), $keys, '');
}

sub main_test_inner {
  my ($key, $lckey, $unikey, $keys, $description) = @_;
  perform_test (\&test_present, $key, $keys, $description);
  perform_test (\&test_fetch_present, $key, $keys, $description);
  perform_test (\&test_delete_present, $key, $keys, $description);

  perform_test (\&test_store, $key, $keys, $description, [a=>'cheat']);
  perform_test (\&test_store, $key, $keys, $description, []);

  perform_test (\&test_absent, $lckey, $keys, $description);
  perform_test (\&test_fetch_absent, $lckey, $keys, $description);
  perform_test (\&test_delete_absent, $lckey, $keys, $description);

  return if $unikey eq $key;

  perform_test (\&test_absent, $unikey, $keys, $description);
  perform_test (\&test_fetch_absent, $unikey, $keys, $description);
  perform_test (\&test_delete_absent, $unikey, $keys, $description);
}

sub perform_test {
  my ($test_sub, $key, $keys, $message, @other) = @_;
  my $printable = join ',', map {ord} split //, $key;

  my (%hash, %tiehash);
  tie %tiehash, 'Tie::StdHash';

  @hash{@$keys} = @$keys;
  @tiehash{@$keys} = @$keys;

  &$test_sub (\%hash, $key, $printable, $message, @other);
  &$test_sub (\%tiehash, $key, $printable, "$message tie", @other);
}

sub test_present {
  my ($hash, $key, $printable, $message) = @_;

  ok (exists $hash->{$key}, "hv_exists_ent present$message $printable");
  ok (XS::APItest::Hash::exists ($hash, $key),
      "hv_exists present$message $printable");
}

sub test_absent {
  my ($hash, $key, $printable, $message) = @_;

  ok (!exists $hash->{$key}, "hv_exists_ent absent$message $printable");
  ok (!XS::APItest::Hash::exists ($hash, $key),
      "hv_exists absent$message $printable");
}

sub test_delete_present {
  my ($hash, $key, $printable, $message) = @_;

  my $copy = {};
  my $class = tied %$hash;
  if (defined $class) {
    tie %$copy, ref $class;
  }
  $copy = {%$hash};
  ok (brute_force_exists ($copy, $key),
      "hv_delete_ent present$message $printable");
  is (delete $copy->{$key}, $key, "hv_delete_ent present$message $printable");
  ok (!brute_force_exists ($copy, $key),
      "hv_delete_ent present$message $printable");
  $copy = {%$hash};
  ok (brute_force_exists ($copy, $key),
      "hv_delete present$message $printable");
  is (XS::APItest::Hash::delete ($copy, $key), $key,
      "hv_delete present$message $printable");
  ok (!brute_force_exists ($copy, $key),
      "hv_delete present$message $printable");
}

sub test_delete_absent {
  my ($hash, $key, $printable, $message) = @_;

  my $copy = {};
  my $class = tied %$hash;
  if (defined $class) {
    tie %$copy, ref $class;
  }
  $copy = {%$hash};
  is (delete $copy->{$key}, undef, "hv_delete_ent absent$message $printable");
  $copy = {%$hash};
  is (XS::APItest::Hash::delete ($copy, $key), undef,
      "hv_delete absent$message $printable");
}

sub test_store {
  my ($hash, $key, $printable, $message, $defaults) = @_;
  my $HV_STORE_IS_CRAZY = 1;

  # We are cheating - hv_store returns NULL for a store into an empty
  # tied hash. This isn't helpful here.

  my $class = tied %$hash;

  # It's important to do this with nice new hashes created each time round
  # the loop, rather than hashes in the pad, which get recycled, and may have
  # xhv_array non-NULL
  my $h1 = {@$defaults};
  my $h2 = {@$defaults};
  if (defined $class) {
    tie %$h1, ref $class;
    tie %$h2, ref $class;
    if ($] > 5.009) {
      # bug 36327 is fixed
      $HV_STORE_IS_CRAZY = undef;
    } else {
      # HV store_ent returns 1 if there was already underlying hash storage
      $HV_STORE_IS_CRAZY = undef unless @$defaults;
    }
  }
  is (XS::APItest::Hash::store_ent($h1, $key, 1), $HV_STORE_IS_CRAZY,
      "hv_store_ent$message $printable");
  ok (brute_force_exists ($h1, $key), "hv_store_ent$message $printable");
  is (XS::APItest::Hash::store($h2, $key,  1), $HV_STORE_IS_CRAZY,
      "hv_store$message $printable");
  ok (brute_force_exists ($h2, $key), "hv_store$message $printable");
}

sub test_fetch_present {
  my ($hash, $key, $printable, $message) = @_;

  is ($hash->{$key}, $key, "hv_fetch_ent present$message $printable");
  is (XS::APItest::Hash::fetch ($hash, $key), $key,
      "hv_fetch present$message $printable");
}

sub test_fetch_absent {
  my ($hash, $key, $printable, $message) = @_;

  is ($hash->{$key}, undef, "hv_fetch_ent absent$message $printable");
  is (XS::APItest::Hash::fetch ($hash, $key), undef,
      "hv_fetch absent$message $printable");
}

sub brute_force_exists {
  my ($hash, $key) = @_;
  foreach (keys %$hash) {
    return 1 if $key eq $_;
  }
  return 0;
}

sub rot13 {
    my @results = map {my $a = $_; $a =~ tr/A-Za-z/N-ZA-Mn-za-m/; $a} @_;
    wantarray ? @results : $results[0];
}

sub bitflip {
    my @results = map {join '', map {chr(32 ^ ord $_)} split '', $_} @_;
    wantarray ? @results : $results[0];
}
Commit	Line	Data
0314122a	1	#!perl -w
	2
	3	BEGIN {
	4	chdir 't' if -d 't';
	5	@INC = '../lib';
	6	push @INC, "::lib:$MacPerl::Architecture:" if $^O eq 'MacOS';
	7	require Config; import Config;
	8	if ($Config{'extensions'} !~ /\bXS\/APItest\b/) {
	9	# Look, I'm using this fully-qualified variable more than once!
	10	my $arch = $MacPerl::Architecture;
	11	print "1..0 # Skip: XS::APItest was not built\n";
	12	exit 0;
	13	}
	14	}
	15
3128e575	16	use strict;
3128e575	17	use utf8;
0314122a	18	use Tie::Hash;
3128e575	19	use Test::More 'no_plan';
3128e575	20
55289a74	21	BEGIN {use_ok('XS::APItest')};
0314122a	22
3128e575	23	sub preform_test;
	24	sub test_present;
	25	sub test_absent;
	26	sub test_delete_present;
	27	sub test_delete_absent;
	28	sub brute_force_exists;
	29	sub test_store;
	30	sub test_fetch_present;
	31	sub test_fetch_absent;
0314122a	32
b60cf05a	33	my $utf8_for_258 = chr 258;
b60cf05a	34	utf8::encode $utf8_for_258;
0314122a	35
3128e575	36	my @testkeys = ('N', chr 198, chr 256);
b60cf05a	37	my @keys = (@testkeys, $utf8_for_258);
0314122a	38
3128e575	39	foreach (@keys) {
	40	utf8::downgrade $_, 1;
	41	}
	42	main_tests (\@keys, \@testkeys, '');
0314122a	43
3128e575	44	foreach (@keys) {
	45	utf8::upgrade $_;
	46	}
	47	main_tests (\@keys, \@testkeys, ' [utf8 hash]');
0314122a	48
3128e575	49	{
	50	my %h = (a=>'cheat');
	51	tie %h, 'Tie::StdHash';
9568a123	52	# is bug 36327 fixed?
	53	my $result = ($] > 5.009) ? undef : 1;
	54
	55	is (XS::APItest::Hash::store(\%h, chr 258, 1), $result);
3128e575	56
	57	ok (!exists $h{$utf8_for_258},
	58	"hv_store doesn't insert a key with the raw utf8 on a tied hash");
	59	}
0314122a	60
9568a123	61	if ($] > 5.009) {
5d2b1485	62	my $strtab = strtab();
5d2b1485	63	is (ref $strtab, 'HASH', "The shared string table quacks like a hash");
8ca60cef	64	my $wibble = "\0";
5d2b1485	65	eval {
8ca60cef	66	$strtab->{$wibble}++;
5d2b1485	67	};
	68	my $prefix = "Cannot modify shared string table in hv_";
	69	my $what = $prefix . 'fetch';
	70	like ($@, qr/^$what/,$what);
	71	eval {
	72	XS::APItest::Hash::store($strtab, 'Boom!', 1)
	73	};
	74	$what = $prefix . 'store';
	75	like ($@, qr/^$what/, $what);
	76	if (0) {
	77	A::B->method();
	78	}
	79	# DESTROY should be in there.
	80	eval {
	81	delete $strtab->{DESTROY};
	82	};
	83	$what = $prefix . 'delete';
	84	like ($@, qr/^$what/, $what);
	85	# I can't work out how to get to the code that flips the wasutf8 flag on
	86	# the hash key without some ikcy XS
	87	}
2dc92170	88
	89	{
	90	is_deeply([&XS::APItest::Hash::test_hv_free_ent], [2,2,1,1],
	91	"hv_free_ent frees the value immediately");
	92	is_deeply([&XS::APItest::Hash::test_hv_delayfree_ent], [2,2,2,1],
	93	"hv_delayfree_ent keeps the value around until FREETMPS");
	94	}
35ab5632	95
	96	foreach my $in ("", "N", "a\0b") {
	97	my $got = XS::APItest::Hash::test_share_unshare_pvn($in);
	98	is ($got, $in, "test_share_unshare_pvn");
	99	}
	100
55289a74	101	if ($] > 5.009) {
53c40a8f	102	foreach ([\&XS::APItest::Hash::rot13_hash, \&rot13, "rot 13"],
	103	[\&XS::APItest::Hash::bitflip_hash, \&bitflip, "bitflip"],
	104	) {
	105	my ($setup, $mapping, $name) = @$_;
	106	my %hash;
	107	my %placebo = (a => 1, p => 2, i => 4, e => 8);
	108	$setup->(\%hash);
	109	$hash{a}++; @hash{qw(p i e)} = (2, 4, 8);
	110
	111	test_U_hash(\%hash, \%placebo, [f => 9, g => 10, h => 11], $mapping,
	112	$name);
	113	}
850f5f16	114	foreach my $upgrade_o (0, 1) {
	115	foreach my $upgrade_n (0, 1) {
	116	my (%hash, %placebo);
	117	XS::APItest::Hash::bitflip_hash(\%hash);
	118	foreach my $new (["7", 65, 67, 80],
	119	["8", 163, 171, 215],
	120	["U", 2603, 2604, 2604],
	121	) {
	122	foreach my $code (78, 240, 256, 1336) {
	123	my $key = chr $code;
	124	# This is the UTF-8 byte sequence for the key.
	125	my $key_utf8 = $key;
	126	utf8::encode($key_utf8);
	127	if ($upgrade_o) {
	128	$key .= chr 256;
	129	chop $key;
	130	}
	131	$hash{$key} = $placebo{$key} = $code;
	132	$hash{$key_utf8} = $placebo{$key_utf8} = "$code as UTF-8";
	133	}
	134	my $name = 'bitflip ' . shift @$new;
	135	my @new_kv;
	136	foreach my $code (@$new) {
	137	my $key = chr $code;
	138	if ($upgrade_n) {
	139	$key .= chr 256;
	140	chop $key;
	141	}
	142	push @new_kv, $key, $_;
	143	}
	144
	145	$name .= ' upgraded(orig) ' if $upgrade_o;
	146	$name .= ' upgraded(new) ' if $upgrade_n;
	147	test_U_hash(\%hash, \%placebo, \@new_kv, \&bitflip, $name);
	148	}
	149	}
	150	}
53c40a8f	151	}
53c40a8f	152
527df579	153	{
	154	my $as_utf8 = "\241" . chr 256;
	155	chop $as_utf8;
	156	my $as_bytes = "\243";
	157	foreach my $key ('N', $as_bytes, $as_utf8, "\x{2623}") {
	158	my $ord = ord $key;
	159	foreach my $hash_pv (0, 1) {
	160	my %hash;
	161	is (XS::APItest::Hash::common({hv => \%hash, keypv => $key,
	162	val => $ord, hash_pv => $hash_pv,
	163	action =>
	164	XS::APItest::HV_FETCH_ISSTORE}),
	165	$ord, "store $ord \$hash_pv = $hash_pv");
	166	is_deeply ([each %hash], [$key, $ord], "First key read is good");
	167	is_deeply ([each %hash], [], "No second key good");
	168
	169	is ($hash{$key}, $ord, "Direct hash read finds $ord");
	170	}
	171	}
	172	}
	173
53c40a8f	174	exit;
	175
	176	################################ The End ################################
	177
	178	sub test_U_hash {
	179	my ($hash, $placebo, $new, $mapping, $message) = @_;
	180	my @hitlist = keys %$placebo;
	181	print "# $message\n";
b54b4831	182
53c40a8f	183	my @keys = sort keys %$hash;
	184	is ("@keys", join(' ', sort($mapping->(keys %$placebo))),
	185	"uvar magic called exactly once on store");
b54b4831	186
850f5f16	187	is (keys %$hash, keys %$placebo);
55289a74	188
53c40a8f	189	my $victim = shift @hitlist;
53c40a8f	190	is (delete $hash->{$victim}, delete $placebo->{$victim});
55289a74	191
850f5f16	192	is (keys %$hash, keys %$placebo);
53c40a8f	193	@keys = sort keys %$hash;
53c40a8f	194	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
55289a74	195
53c40a8f	196	$victim = shift @hitlist;
53c40a8f	197	is (XS::APItest::Hash::delete_ent ($hash, $victim,
55289a74	198	XS::APItest::HV_DISABLE_UVAR_XKEY),
55289a74	199	undef, "Deleting a known key with conversion disabled fails (ent)");
850f5f16	200	is (keys %$hash, keys %$placebo);
55289a74	201
53c40a8f	202	is (XS::APItest::Hash::delete_ent ($hash, $victim, 0),
	203	delete $placebo->{$victim},
	204	"Deleting a known key with conversion enabled works (ent)");
850f5f16	205	is (keys %$hash, keys %$placebo);
53c40a8f	206	@keys = sort keys %$hash;
53c40a8f	207	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
55289a74	208
53c40a8f	209	$victim = shift @hitlist;
53c40a8f	210	is (XS::APItest::Hash::delete ($hash, $victim,
55289a74	211	XS::APItest::HV_DISABLE_UVAR_XKEY),
55289a74	212	undef, "Deleting a known key with conversion disabled fails");
850f5f16	213	is (keys %$hash, keys %$placebo);
53c40a8f	214
	215	is (XS::APItest::Hash::delete ($hash, $victim, 0),
	216	delete $placebo->{$victim},
	217	"Deleting a known key with conversion enabled works");
850f5f16	218	is (keys %$hash, keys %$placebo);
53c40a8f	219	@keys = sort keys %$hash;
	220	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
	221
	222	my ($k, $v) = splice @$new, 0, 2;
	223	$hash->{$k} = $v;
	224	$placebo->{$k} = $v;
850f5f16	225	is (keys %$hash, keys %$placebo);
53c40a8f	226	@keys = sort keys %$hash;
	227	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
	228
	229	($k, $v) = splice @$new, 0, 2;
	230	is (XS::APItest::Hash::store_ent($hash, $k, $v), $v, "store_ent");
	231	$placebo->{$k} = $v;
850f5f16	232	is (keys %$hash, keys %$placebo);
53c40a8f	233	@keys = sort keys %$hash;
	234	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
	235
	236	($k, $v) = splice @$new, 0, 2;
	237	is (XS::APItest::Hash::store($hash, $k, $v), $v, "store");
53c40a8f	238	$placebo->{$k} = $v;
850f5f16	239	is (keys %$hash, keys %$placebo);
53c40a8f	240	@keys = sort keys %$hash;
	241	is ("@keys", join(' ', sort($mapping->(keys %$placebo))));
	242
	243	@hitlist = keys %$placebo;
	244	$victim = shift @hitlist;
	245	is (XS::APItest::Hash::fetch_ent($hash, $victim), $placebo->{$victim},
	246	"fetch_ent");
	247	is (XS::APItest::Hash::fetch_ent($hash, $mapping->($victim)), undef,
bdee33e4	248	"fetch_ent (missing)");
bdee33e4	249
53c40a8f	250	$victim = shift @hitlist;
	251	is (XS::APItest::Hash::fetch($hash, $victim), $placebo->{$victim},
	252	"fetch");
	253	is (XS::APItest::Hash::fetch($hash, $mapping->($victim)), undef,
bdee33e4	254	"fetch (missing)");
bdee33e4	255
53c40a8f	256	$victim = shift @hitlist;
	257	ok (XS::APItest::Hash::exists_ent($hash, $victim), "exists_ent");
	258	ok (!XS::APItest::Hash::exists_ent($hash, $mapping->($victim)),
bdee33e4	259	"exists_ent (missing)");
bdee33e4	260
53c40a8f	261	$victim = shift @hitlist;
6b4de907	262	die "Need a victim" unless defined $victim;
53c40a8f	263	ok (XS::APItest::Hash::exists($hash, $victim), "exists");
	264	ok (!XS::APItest::Hash::exists($hash, $mapping->($victim)),
	265	"exists (missing)");
6b4de907	266
	267	is (XS::APItest::Hash::common({hv => $hash, keysv => $victim}),
	268	$placebo->{$victim}, "common (fetch)");
	269	is (XS::APItest::Hash::common({hv => $hash, keypv => $victim}),
	270	$placebo->{$victim}, "common (fetch pv)");
	271	is (XS::APItest::Hash::common({hv => $hash, keysv => $victim,
	272	action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	273	undef, "common (fetch) missing");
	274	is (XS::APItest::Hash::common({hv => $hash, keypv => $victim,
	275	action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	276	undef, "common (fetch pv) missing");
	277	is (XS::APItest::Hash::common({hv => $hash, keysv => $mapping->($victim),
	278	action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	279	$placebo->{$victim}, "common (fetch) missing mapped");
	280	is (XS::APItest::Hash::common({hv => $hash, keypv => $mapping->($victim),
	281	action => XS::APItest::HV_DISABLE_UVAR_XKEY}),
	282	$placebo->{$victim}, "common (fetch pv) missing mapped");
b54b4831	283	}
b54b4831	284
3128e575	285	sub main_tests {
	286	my ($keys, $testkeys, $description) = @_;
	287	foreach my $key (@$testkeys) {
	288	my $lckey = ($key eq chr 198) ? chr 230 : lc $key;
	289	my $unikey = $key;
	290	utf8::encode $unikey;
0314122a	291
3128e575	292	utf8::downgrade $key, 1;
	293	utf8::downgrade $lckey, 1;
	294	utf8::downgrade $unikey, 1;
	295	main_test_inner ($key, $lckey, $unikey, $keys, $description);
0314122a	296
3128e575	297	utf8::upgrade $key;
	298	utf8::upgrade $lckey;
	299	utf8::upgrade $unikey;
	300	main_test_inner ($key, $lckey, $unikey, $keys,
	301	$description . ' [key utf8 on]');
	302	}
0314122a	303
3128e575	304	# hv_exists was buggy for tied hashes, in that the raw utf8 key was being
	305	# used - the utf8 flag was being lost.
	306	perform_test (\&test_absent, (chr 258), $keys, '');
0314122a	307
3128e575	308	perform_test (\&test_fetch_absent, (chr 258), $keys, '');
3128e575	309	perform_test (\&test_delete_absent, (chr 258), $keys, '');
0314122a	310	}
0314122a	311
3128e575	312	sub main_test_inner {
	313	my ($key, $lckey, $unikey, $keys, $description) = @_;
	314	perform_test (\&test_present, $key, $keys, $description);
	315	perform_test (\&test_fetch_present, $key, $keys, $description);
	316	perform_test (\&test_delete_present, $key, $keys, $description);
b60cf05a	317
3128e575	318	perform_test (\&test_store, $key, $keys, $description, [a=>'cheat']);
3128e575	319	perform_test (\&test_store, $key, $keys, $description, []);
b60cf05a	320
3128e575	321	perform_test (\&test_absent, $lckey, $keys, $description);
	322	perform_test (\&test_fetch_absent, $lckey, $keys, $description);
	323	perform_test (\&test_delete_absent, $lckey, $keys, $description);
b60cf05a	324
3128e575	325	return if $unikey eq $key;
	326
	327	perform_test (\&test_absent, $unikey, $keys, $description);
	328	perform_test (\&test_fetch_absent, $unikey, $keys, $description);
	329	perform_test (\&test_delete_absent, $unikey, $keys, $description);
b60cf05a	330	}
b60cf05a	331
3128e575	332	sub perform_test {
3128e575	333	my ($test_sub, $key, $keys, $message, @other) = @_;
b60cf05a	334	my $printable = join ',', map {ord} split //, $key;
b60cf05a	335
3128e575	336	my (%hash, %tiehash);
3128e575	337	tie %tiehash, 'Tie::StdHash';
b60cf05a	338
3128e575	339	@hash{@$keys} = @$keys;
3128e575	340	@tiehash{@$keys} = @$keys;
b60cf05a	341
3128e575	342	&$test_sub (\%hash, $key, $printable, $message, @other);
3128e575	343	&$test_sub (\%tiehash, $key, $printable, "$message tie", @other);
b60cf05a	344	}
b60cf05a	345
3128e575	346	sub test_present {
	347	my ($hash, $key, $printable, $message) = @_;
	348
	349	ok (exists $hash->{$key}, "hv_exists_ent present$message $printable");
	350	ok (XS::APItest::Hash::exists ($hash, $key),
	351	"hv_exists present$message $printable");
b60cf05a	352	}
b60cf05a	353
3128e575	354	sub test_absent {
3128e575	355	my ($hash, $key, $printable, $message) = @_;
858117f8	356
3128e575	357	ok (!exists $hash->{$key}, "hv_exists_ent absent$message $printable");
	358	ok (!XS::APItest::Hash::exists ($hash, $key),
	359	"hv_exists absent$message $printable");
b60cf05a	360	}
b60cf05a	361
3128e575	362	sub test_delete_present {
3128e575	363	my ($hash, $key, $printable, $message) = @_;
b60cf05a	364
3128e575	365	my $copy = {};
	366	my $class = tied %$hash;
	367	if (defined $class) {
	368	tie %$copy, ref $class;
	369	}
	370	$copy = {%$hash};
8829b5e2	371	ok (brute_force_exists ($copy, $key),
8829b5e2	372	"hv_delete_ent present$message $printable");
3128e575	373	is (delete $copy->{$key}, $key, "hv_delete_ent present$message $printable");
8829b5e2	374	ok (!brute_force_exists ($copy, $key),
8829b5e2	375	"hv_delete_ent present$message $printable");
3128e575	376	$copy = {%$hash};
8829b5e2	377	ok (brute_force_exists ($copy, $key),
8829b5e2	378	"hv_delete present$message $printable");
3128e575	379	is (XS::APItest::Hash::delete ($copy, $key), $key,
3128e575	380	"hv_delete present$message $printable");
8829b5e2	381	ok (!brute_force_exists ($copy, $key),
8829b5e2	382	"hv_delete present$message $printable");
b60cf05a	383	}
b60cf05a	384
3128e575	385	sub test_delete_absent {
3128e575	386	my ($hash, $key, $printable, $message) = @_;
b60cf05a	387
3128e575	388	my $copy = {};
	389	my $class = tied %$hash;
	390	if (defined $class) {
	391	tie %$copy, ref $class;
	392	}
	393	$copy = {%$hash};
	394	is (delete $copy->{$key}, undef, "hv_delete_ent absent$message $printable");
	395	$copy = {%$hash};
	396	is (XS::APItest::Hash::delete ($copy, $key), undef,
	397	"hv_delete absent$message $printable");
b60cf05a	398	}
b60cf05a	399
3128e575	400	sub test_store {
	401	my ($hash, $key, $printable, $message, $defaults) = @_;
	402	my $HV_STORE_IS_CRAZY = 1;
b60cf05a	403
3128e575	404	# We are cheating - hv_store returns NULL for a store into an empty
3128e575	405	# tied hash. This isn't helpful here.
0314122a	406
3128e575	407	my $class = tied %$hash;
0314122a	408
9568a123	409	# It's important to do this with nice new hashes created each time round
	410	# the loop, rather than hashes in the pad, which get recycled, and may have
	411	# xhv_array non-NULL
	412	my $h1 = {@$defaults};
	413	my $h2 = {@$defaults};
3128e575	414	if (defined $class) {
9568a123	415	tie %$h1, ref $class;
	416	tie %$h2, ref $class;
	417	if ($] > 5.009) {
	418	# bug 36327 is fixed
	419	$HV_STORE_IS_CRAZY = undef;
	420	} else {
	421	# HV store_ent returns 1 if there was already underlying hash storage
	422	$HV_STORE_IS_CRAZY = undef unless @$defaults;
	423	}
3128e575	424	}
9568a123	425	is (XS::APItest::Hash::store_ent($h1, $key, 1), $HV_STORE_IS_CRAZY,
	426	"hv_store_ent$message $printable");
	427	ok (brute_force_exists ($h1, $key), "hv_store_ent$message $printable");
	428	is (XS::APItest::Hash::store($h2, $key, 1), $HV_STORE_IS_CRAZY,
3128e575	429	"hv_store$message $printable");
9568a123	430	ok (brute_force_exists ($h2, $key), "hv_store$message $printable");
3128e575	431	}
0314122a	432
3128e575	433	sub test_fetch_present {
3128e575	434	my ($hash, $key, $printable, $message) = @_;
b60cf05a	435
3128e575	436	is ($hash->{$key}, $key, "hv_fetch_ent present$message $printable");
	437	is (XS::APItest::Hash::fetch ($hash, $key), $key,
	438	"hv_fetch present$message $printable");
0314122a	439	}
0314122a	440
3128e575	441	sub test_fetch_absent {
3128e575	442	my ($hash, $key, $printable, $message) = @_;
b60cf05a	443
3128e575	444	is ($hash->{$key}, undef, "hv_fetch_ent absent$message $printable");
	445	is (XS::APItest::Hash::fetch ($hash, $key), undef,
	446	"hv_fetch absent$message $printable");
	447	}
b60cf05a	448
3128e575	449	sub brute_force_exists {
	450	my ($hash, $key) = @_;
	451	foreach (keys %$hash) {
	452	return 1 if $key eq $_;
	453	}
	454	return 0;
b60cf05a	455	}
b54b4831	456
	457	sub rot13 {
	458	my @results = map {my $a = $_; $a =~ tr/A-Za-z/N-ZA-Mn-za-m/; $a} @_;
	459	wantarray ? @results : $results[0];
	460	}
53c40a8f	461
	462	sub bitflip {
	463	my @results = map {join '', map {chr(32 ^ ord $_)} split '', $_} @_;
	464	wantarray ? @results : $results[0];
	465	}