1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
# INTERNAL MODULE: guts for HashRef type from Types::Standard.
package Types::Standard::HashRef;
use 5.008001;
use strict;
use warnings;
BEGIN {
$Types::Standard::HashRef::AUTHORITY = 'cpan:TOBYINK';
$Types::Standard::HashRef::VERSION = '2.010001';
}
$Types::Standard::HashRef::VERSION =~ tr/_//d;
use Type::Tiny ();
use Types::Standard ();
use Types::TypeTiny ();
sub _croak ($;@) { require Error::TypeTiny; goto \&Error::TypeTiny::croak }
use Exporter::Tiny 1.004001 ();
our @ISA = qw( Exporter::Tiny );
sub _exporter_fail {
my ( $class, $type_name, $values, $globals ) = @_;
my $caller = $globals->{into};
my $of = exists( $values->{of} ) ? $values->{of} : $values->{type};
defined $of or _croak( qq{Expected option "of" for type "$type_name"} );
if ( not Types::TypeTiny::is_TypeTiny($of) ) {
require Type::Utils;
$of = Type::Utils::dwim_type( $of, for => $caller );
}
my $type = Types::Standard::HashRef->of( $of );
$type = $type->create_child_type(
name => $type_name,
$type->has_coercion ? ( coercion => 1 ) : (),
exists( $values->{where} ) ? ( constraint => $values->{where} ) : (),
);
$INC{'Type/Registry.pm'}
? 'Type::Registry'->for_class( $caller )->add_type( $type, $type_name )
: ( $Type::Registry::DELAYED{$caller}{$type_name} = $type )
unless( ref($caller) or $caller eq '-lexical' or $globals->{'lexical'} );
return map +( $_->{name} => $_->{code} ), @{ $type->exportables };
}
no warnings;
sub __constraint_generator {
return Types::Standard::HashRef unless @_;
require Error::TypeTiny::WrongNumberOfParameters;
Type::Tiny::check_parameter_count_for_parameterized_type( 'Types::Standard', 'HashRef', \@_, 1 );
my $param = shift;
Types::TypeTiny::is_TypeTiny( $param )
or _croak(
"Parameter to HashRef[`a] expected to be a type constraint; got $param" );
my $param_compiled_check = $param->compiled_check;
my $xsub;
if ( Type::Tiny::_USE_XS ) {
my $paramname = Type::Tiny::XS::is_known( $param_compiled_check );
$xsub = Type::Tiny::XS::get_coderef_for( "HashRef[$paramname]" )
if $paramname;
}
elsif ( Type::Tiny::_USE_MOUSE and $param->_has_xsub ) {
require Mouse::Util::TypeConstraints;
my $maker = "Mouse::Util::TypeConstraints"->can( "_parameterize_HashRef_for" );
$xsub = $maker->( $param ) if $maker;
}
return (
sub {
my $hash = shift;
$param->check( $_ ) || return for values %$hash;
return !!1;
},
$xsub,
);
} #/ sub __constraint_generator
sub __inline_generator {
my $param = shift;
my $compiled = $param->compiled_check;
my $xsubname;
if ( Type::Tiny::_USE_XS and not $Type::Tiny::AvoidCallbacks ) {
my $paramname = Type::Tiny::XS::is_known( $compiled );
$xsubname = Type::Tiny::XS::get_subname_for( "HashRef[$paramname]" );
}
return unless $param->can_be_inlined;
return sub {
my $v = $_[1];
return "$xsubname\($v\)" if $xsubname && !$Type::Tiny::AvoidCallbacks;
my $p = Types::Standard::HashRef->inline_check( $v );
my $param_check = $param->inline_check( '$i' );
"$p and do { "
. "my \$ok = 1; "
. "for my \$i (values \%{$v}) { "
. "(\$ok = 0, last) unless $param_check " . "}; " . "\$ok " . "}";
};
} #/ sub __inline_generator
sub __deep_explanation {
require B;
my ( $type, $value, $varname ) = @_;
my $param = $type->parameters->[0];
for my $k ( sort keys %$value ) {
my $item = $value->{$k};
next if $param->check( $item );
return [
sprintf( '"%s" constrains each value in the hash with "%s"', $type, $param ),
@{
$param->validate_explain(
$item, sprintf( '%s->{%s}', $varname, B::perlstring( $k ) )
)
},
];
} #/ for my $k ( sort keys %$value)
# This should never happen...
return; # uncoverable statement
} #/ sub __deep_explanation
sub __coercion_generator {
my ( $parent, $child, $param ) = @_;
return unless $param->has_coercion;
my $coercable_item = $param->coercion->_source_type_union;
my $C = "Type::Coercion"->new( type_constraint => $child );
if ( $param->coercion->can_be_inlined and $coercable_item->can_be_inlined ) {
$C->add_type_coercions(
$parent => Types::Standard::Stringable {
my @code;
push @code, 'do { my ($orig, $return_orig, %new) = ($_, 0);';
push @code, 'for (keys %$orig) {';
push @code,
sprintf(
'$return_orig++ && last unless (%s);',
$coercable_item->inline_check( '$orig->{$_}' )
);
push @code,
sprintf(
'$new{$_} = (%s);',
$param->coercion->inline_coercion( '$orig->{$_}' )
);
push @code, '}';
push @code, '$return_orig ? $orig : \\%new';
push @code, '}';
"@code";
}
);
} #/ if ( $param->coercion->...)
else {
$C->add_type_coercions(
$parent => sub {
my $value = @_ ? $_[0] : $_;
my %new;
for my $k ( keys %$value ) {
return $value unless $coercable_item->check( $value->{$k} );
$new{$k} = $param->coerce( $value->{$k} );
}
return \%new;
},
);
} #/ else [ if ( $param->coercion->...)]
return $C;
} #/ sub __coercion_generator
sub __hashref_allows_key {
my $self = shift;
Types::Standard::is_Str( $_[0] );
}
sub __hashref_allows_value {
my $self = shift;
my ( $key, $value ) = @_;
return !!0 unless $self->my_hashref_allows_key( $key );
return !!1 if $self == Types::Standard::HashRef();
my $href = $self->find_parent(
sub { $_->has_parent && $_->parent == Types::Standard::HashRef() } );
my $param = $href->type_parameter;
Types::Standard::is_Str( $key ) and $param->check( $value );
} #/ sub __hashref_allows_value
1;
__END__
=pod
=encoding utf-8
=head1 NAME
Types::Standard::HashRef - exporter utility for the B<HashRef> type constraint
=head1 SYNOPSIS
use Types::Standard -types;
# Normal way to validate a hashref of integers.
#
HashRef->of( Int )->assert_valid( { one => 1 } );
use Types::Standard::HashRef IntHash => { of => Int },
# Exported shortcut
#
assert_IntHash { one => 1 };
=head1 STATUS
This module is not covered by the
L<Type-Tiny stability policy|Type::Tiny::Manual::Policies/"STABILITY">.
=head1 DESCRIPTION
This is mostly internal code, but can also act as an exporter utility.
=head2 Exports
Types::Standard::HashRef can be used experimentally as an exporter.
use Types::Standard 'Int';
use Types::Standard::HashRef IntHash => { of => Int };
This will export the following functions into your namespace:
=over
=item C<< IntHash >>
=item C<< is_IntHash( $value ) >>
=item C<< assert_IntHash( $value ) >>
=item C<< to_IntHash( $value ) >>
=back
Multiple types can be exported at once:
use Types::Standard -types;
use Types::Standard::HashRef (
IntHash => { of => Int },
NumHash => { of => Num },
StrHash => { of => Str },
);
assert_IntHash { two => 2 }; # should not die
It's possible to further constrain the hashref using C<where>:
use Types::Standard::HashRef MyThing => { of => Int, where => sub { ... } };
=head1 BUGS
Please report any bugs to
L<https://github.com/tobyink/p5-type-tiny/issues>.
=head1 SEE ALSO
L<Types::Standard>.
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2013-2025 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 DISCLAIMER OF WARRANTIES
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|