/usr/lib/perl5/Moose/Util/TypeConstraints.pm is in libmoose-perl 2.0401-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 | package Moose::Util::TypeConstraints;
BEGIN {
$Moose::Util::TypeConstraints::AUTHORITY = 'cpan:STEVAN';
}
{
$Moose::Util::TypeConstraints::VERSION = '2.0401';
}
use Carp ();
use List::MoreUtils qw( all any );
use Scalar::Util qw( blessed reftype );
use Moose::Exporter;
## --------------------------------------------------------
# Prototyped subs must be predeclared because we have a
# circular dependency with Moose::Meta::Attribute et. al.
# so in case of us being use'd first the predeclaration
# ensures the prototypes are in scope when consumers are
# compiled.
# dah sugah!
sub where (&);
sub via (&);
sub message (&);
sub optimize_as (&);
sub inline_as (&);
## --------------------------------------------------------
use Moose::Deprecated;
use Moose::Meta::TypeConstraint;
use Moose::Meta::TypeConstraint::Union;
use Moose::Meta::TypeConstraint::Parameterized;
use Moose::Meta::TypeConstraint::Parameterizable;
use Moose::Meta::TypeConstraint::Class;
use Moose::Meta::TypeConstraint::Role;
use Moose::Meta::TypeConstraint::Enum;
use Moose::Meta::TypeConstraint::DuckType;
use Moose::Meta::TypeCoercion;
use Moose::Meta::TypeCoercion::Union;
use Moose::Meta::TypeConstraint::Registry;
Moose::Exporter->setup_import_methods(
as_is => [
qw(
type subtype class_type role_type maybe_type duck_type
as where message optimize_as inline_as
coerce from via
enum union
find_type_constraint
register_type_constraint
match_on_type )
],
);
## --------------------------------------------------------
## type registry and some useful functions for it
## --------------------------------------------------------
my $REGISTRY = Moose::Meta::TypeConstraint::Registry->new;
sub get_type_constraint_registry {$REGISTRY}
sub list_all_type_constraints { keys %{ $REGISTRY->type_constraints } }
sub export_type_constraints_as_functions {
my $pkg = caller();
no strict 'refs';
foreach my $constraint ( keys %{ $REGISTRY->type_constraints } ) {
my $tc = $REGISTRY->get_type_constraint($constraint)
->_compiled_type_constraint;
*{"${pkg}::${constraint}"}
= sub { $tc->( $_[0] ) ? 1 : undef }; # the undef is for compat
}
}
sub create_type_constraint_union {
_create_type_constraint_union(\@_);
}
sub create_named_type_constraint_union {
my $name = shift;
_create_type_constraint_union($name, \@_);
}
sub _create_type_constraint_union {
my $name;
$name = shift if @_ > 1;
my @tcs = @{ shift() };
my @type_constraint_names;
if ( scalar @tcs == 1 && _detect_type_constraint_union( $tcs[0] ) ) {
@type_constraint_names = _parse_type_constraint_union( $tcs[0] );
}
else {
@type_constraint_names = @tcs;
}
( scalar @type_constraint_names >= 2 )
|| __PACKAGE__->_throw_error(
"You must pass in at least 2 type names to make a union");
my @type_constraints = map {
find_or_parse_type_constraint($_)
|| __PACKAGE__->_throw_error(
"Could not locate type constraint ($_) for the union");
} @type_constraint_names;
my %options = (
type_constraints => \@type_constraints
);
$options{name} = $name if defined $name;
return Moose::Meta::TypeConstraint::Union->new(%options);
}
sub create_parameterized_type_constraint {
my $type_constraint_name = shift;
my ( $base_type, $type_parameter )
= _parse_parameterized_type_constraint($type_constraint_name);
( defined $base_type && defined $type_parameter )
|| __PACKAGE__->_throw_error(
"Could not parse type name ($type_constraint_name) correctly");
if ( $REGISTRY->has_type_constraint($base_type) ) {
my $base_type_tc = $REGISTRY->get_type_constraint($base_type);
return _create_parameterized_type_constraint(
$base_type_tc,
$type_parameter
);
}
else {
__PACKAGE__->_throw_error(
"Could not locate the base type ($base_type)");
}
}
sub _create_parameterized_type_constraint {
my ( $base_type_tc, $type_parameter ) = @_;
if ( $base_type_tc->can('parameterize') ) {
return $base_type_tc->parameterize($type_parameter);
}
else {
return Moose::Meta::TypeConstraint::Parameterized->new(
name => $base_type_tc->name . '[' . $type_parameter . ']',
parent => $base_type_tc,
type_parameter =>
find_or_create_isa_type_constraint($type_parameter),
);
}
}
#should we also support optimized checks?
sub create_class_type_constraint {
my ( $class, $options ) = @_;
# too early for this check
#find_type_constraint("ClassName")->check($class)
# || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
my $pkg_defined_in = $options->{package_defined_in} || scalar( caller(1) );
if (my $type = $REGISTRY->get_type_constraint($class)) {
if (!($type->isa('Moose::Meta::TypeConstraint::Class') && $type->class eq $class)) {
_confess(
"The type constraint '$class' has already been created in "
. $type->_package_defined_in
. " and cannot be created again in "
. $pkg_defined_in )
}
}
my %options = (
class => $class,
name => $class,
package_defined_in => $pkg_defined_in,
%{ $options || {} },
);
$options{name} ||= "__ANON__";
my $tc = Moose::Meta::TypeConstraint::Class->new(%options);
$REGISTRY->add_type_constraint($tc);
return $tc;
}
sub create_role_type_constraint {
my ( $role, $options ) = @_;
# too early for this check
#find_type_constraint("ClassName")->check($class)
# || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
my $pkg_defined_in = $options->{package_defined_in} || scalar( caller(1) );
if (my $type = $REGISTRY->get_type_constraint($role)) {
if (!($type->isa('Moose::Meta::TypeConstraint::Role') && $type->role eq $role)) {
_confess(
"The type constraint '$role' has already been created in "
. $type->_package_defined_in
. " and cannot be created again in "
. $pkg_defined_in )
}
}
my %options = (
role => $role,
name => $role,
package_defined_in => $pkg_defined_in,
%{ $options || {} },
);
$options{name} ||= "__ANON__";
my $tc = Moose::Meta::TypeConstraint::Role->new(%options);
$REGISTRY->add_type_constraint($tc);
return $tc;
}
sub find_or_create_type_constraint {
my ( $type_constraint_name, $options_for_anon_type ) = @_;
if ( my $constraint
= find_or_parse_type_constraint($type_constraint_name) ) {
return $constraint;
}
elsif ( defined $options_for_anon_type ) {
# NOTE:
# if there is no $options_for_anon_type
# specified, then we assume they don't
# want to create one, and return nothing.
# otherwise assume that we should create
# an ANON type with the $options_for_anon_type
# options which can be passed in. It should
# be noted that these don't get registered
# so we need to return it.
# - SL
return Moose::Meta::TypeConstraint->new(
name => '__ANON__',
%{$options_for_anon_type}
);
}
return;
}
sub find_or_create_isa_type_constraint {
my ($type_constraint_name, $options) = @_;
find_or_parse_type_constraint($type_constraint_name)
|| create_class_type_constraint($type_constraint_name, $options);
}
sub find_or_create_does_type_constraint {
my ($type_constraint_name, $options) = @_;
find_or_parse_type_constraint($type_constraint_name)
|| create_role_type_constraint($type_constraint_name, $options);
}
sub find_or_parse_type_constraint {
my $type_constraint_name = normalize_type_constraint_name(shift);
my $constraint;
if ( $constraint = find_type_constraint($type_constraint_name) ) {
return $constraint;
}
elsif ( _detect_type_constraint_union($type_constraint_name) ) {
$constraint = create_type_constraint_union($type_constraint_name);
}
elsif ( _detect_parameterized_type_constraint($type_constraint_name) ) {
$constraint
= create_parameterized_type_constraint($type_constraint_name);
}
else {
return;
}
$REGISTRY->add_type_constraint($constraint);
return $constraint;
}
sub normalize_type_constraint_name {
my $type_constraint_name = shift;
$type_constraint_name =~ s/\s//g;
return $type_constraint_name;
}
sub _confess {
my $error = shift;
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
Carp::confess($error);
}
## --------------------------------------------------------
## exported functions ...
## --------------------------------------------------------
sub find_type_constraint {
my $type = shift;
if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) {
return $type;
}
else {
return unless $REGISTRY->has_type_constraint($type);
return $REGISTRY->get_type_constraint($type);
}
}
sub register_type_constraint {
my $constraint = shift;
__PACKAGE__->_throw_error("can't register an unnamed type constraint")
unless defined $constraint->name;
$REGISTRY->add_type_constraint($constraint);
return $constraint;
}
# type constructors
sub type {
my $name = shift;
my %p = map { %{$_} } @_;
return _create_type_constraint(
$name, undef, $p{where}, $p{message},
$p{optimize_as}, $p{inline_as},
);
}
sub subtype {
if ( @_ == 1 && !ref $_[0] ) {
__PACKAGE__->_throw_error(
'A subtype cannot consist solely of a name, it must have a parent'
);
}
# The blessed check is mostly to accommodate MooseX::Types, which
# uses an object which overloads stringification as a type name.
my $name = ref $_[0] && !blessed $_[0] ? undef : shift;
my %p = map { %{$_} } @_;
# subtype Str => where { ... };
if ( !exists $p{as} ) {
$p{as} = $name;
$name = undef;
}
return _create_type_constraint(
$name, $p{as}, $p{where}, $p{message},
$p{optimize_as}, $p{inline_as},
);
}
sub class_type {
create_class_type_constraint(@_);
}
sub role_type ($;$) {
create_role_type_constraint(@_);
}
sub maybe_type {
my ($type_parameter) = @_;
register_type_constraint(
$REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter)
);
}
sub duck_type {
my ( $type_name, @methods ) = @_;
if ( ref $type_name eq 'ARRAY' && !@methods ) {
@methods = @$type_name;
$type_name = undef;
}
if ( @methods == 1 && ref $methods[0] eq 'ARRAY' ) {
@methods = @{ $methods[0] };
}
register_type_constraint(
create_duck_type_constraint(
$type_name,
\@methods,
)
);
}
sub coerce {
my ( $type_name, @coercion_map ) = @_;
_install_type_coercions( $type_name, \@coercion_map );
}
# The trick of returning @_ lets us avoid having to specify a
# prototype. Perl will parse this:
#
# subtype 'Foo'
# => as 'Str'
# => where { ... }
#
# as this:
#
# subtype( 'Foo', as( 'Str', where { ... } ) );
#
# If as() returns all its extra arguments, this just works, and
# preserves backwards compatibility.
sub as { { as => shift }, @_ }
sub where (&) { { where => $_[0] } }
sub message (&) { { message => $_[0] } }
sub optimize_as (&) { { optimize_as => $_[0] } }
sub inline_as (&) { { inline_as => $_[0] } }
sub from {@_}
sub via (&) { $_[0] }
sub enum {
my ( $type_name, @values ) = @_;
# NOTE:
# if only an array-ref is passed then
# you get an anon-enum
# - SL
if ( ref $type_name eq 'ARRAY' ) {
@values == 0
|| __PACKAGE__->_throw_error("enum called with an array reference and additional arguments. Did you mean to parenthesize the enum call's parameters?");
@values = @$type_name;
$type_name = undef;
}
if ( @values == 1 && ref $values[0] eq 'ARRAY' ) {
@values = @{ $values[0] };
}
register_type_constraint(
create_enum_type_constraint(
$type_name,
\@values,
)
);
}
sub union {
my ( $type_name, @constraints ) = @_;
if ( ref $type_name eq 'ARRAY' ) {
@constraints == 0
|| __PACKAGE__->_throw_error("union called with an array reference and additional arguments.");
@constraints = @$type_name;
$type_name = undef;
}
if ( @constraints == 1 && ref $constraints[0] eq 'ARRAY' ) {
@constraints = @{ $constraints[0] };
}
if ( defined $type_name ) {
return register_type_constraint(
create_named_type_constraint_union( $type_name, @constraints )
);
}
return create_type_constraint_union( @constraints );
}
sub create_enum_type_constraint {
my ( $type_name, $values ) = @_;
Moose::Meta::TypeConstraint::Enum->new(
name => $type_name || '__ANON__',
values => $values,
);
}
sub create_duck_type_constraint {
my ( $type_name, $methods ) = @_;
Moose::Meta::TypeConstraint::DuckType->new(
name => $type_name || '__ANON__',
methods => $methods,
);
}
sub match_on_type {
my ($to_match, @cases) = @_;
my $default;
if (@cases % 2 != 0) {
$default = pop @cases;
(ref $default eq 'CODE')
|| __PACKAGE__->_throw_error("Default case must be a CODE ref, not $default");
}
while (@cases) {
my ($type, $action) = splice @cases, 0, 2;
unless (blessed $type && $type->isa('Moose::Meta::TypeConstraint')) {
$type = find_or_parse_type_constraint($type)
|| __PACKAGE__->_throw_error("Cannot find or parse the type '$type'")
}
(ref $action eq 'CODE')
|| __PACKAGE__->_throw_error("Match action must be a CODE ref, not $action");
if ($type->check($to_match)) {
local $_ = $to_match;
return $action->($to_match);
}
}
(defined $default)
|| __PACKAGE__->_throw_error("No cases matched for $to_match");
{
local $_ = $to_match;
return $default->($to_match);
}
}
## --------------------------------------------------------
## desugaring functions ...
## --------------------------------------------------------
sub _create_type_constraint ($$$;$$) {
my $name = shift;
my $parent = shift;
my $check = shift;
my $message = shift;
my $optimized = shift;
my $inlined = shift;
my $pkg_defined_in = scalar( caller(1) );
if ( defined $name ) {
my $type = $REGISTRY->get_type_constraint($name);
( $type->_package_defined_in eq $pkg_defined_in )
|| _confess(
"The type constraint '$name' has already been created in "
. $type->_package_defined_in
. " and cannot be created again in "
. $pkg_defined_in )
if defined $type;
$name =~ /^[\w:\.]+$/
or die qq{$name contains invalid characters for a type name.}
. qq{ Names can contain alphanumeric character, ":", and "."\n};
}
my %opts = (
name => $name,
package_defined_in => $pkg_defined_in,
( $check ? ( constraint => $check ) : () ),
( $message ? ( message => $message ) : () ),
( $optimized ? ( optimized => $optimized ) : () ),
( $inlined ? ( inlined => $inlined ) : () ),
);
my $constraint;
if (
defined $parent
and $parent
= blessed $parent
? $parent
: find_or_create_isa_type_constraint($parent)
) {
$constraint = $parent->create_child_type(%opts);
}
else {
$constraint = Moose::Meta::TypeConstraint->new(%opts);
}
$REGISTRY->add_type_constraint($constraint)
if defined $name;
return $constraint;
}
sub _install_type_coercions ($$) {
my ( $type_name, $coercion_map ) = @_;
my $type = find_type_constraint($type_name);
( defined $type )
|| __PACKAGE__->_throw_error(
"Cannot find type '$type_name', perhaps you forgot to load it");
if ( $type->has_coercion ) {
$type->coercion->add_type_coercions(@$coercion_map);
}
else {
my $type_coercion = Moose::Meta::TypeCoercion->new(
type_coercion_map => $coercion_map,
type_constraint => $type
);
$type->coercion($type_coercion);
}
}
## --------------------------------------------------------
## type notation parsing ...
## --------------------------------------------------------
{
# All I have to say is mugwump++ cause I know
# do not even have enough regexp-fu to be able
# to have written this (I can only barely
# understand it as it is)
# - SL
use re "eval";
my $valid_chars = qr{[\w:\.]};
my $type_atom = qr{ (?>$valid_chars+) }x;
my $ws = qr{ (?>\s*) }x;
my $op_union = qr{ $ws \| $ws }x;
my ($type, $type_capture_parts, $type_with_parameter, $union, $any);
if (Class::MOP::IS_RUNNING_ON_5_10) {
my $type_pattern
= q{ (?&type_atom) (?: \[ (?&ws) (?&any) (?&ws) \] )? };
my $type_capture_parts_pattern
= q{ ((?&type_atom)) (?: \[ (?&ws) ((?&any)) (?&ws) \] )? };
my $type_with_parameter_pattern
= q{ (?&type_atom) \[ (?&ws) (?&any) (?&ws) \] };
my $union_pattern
= q{ (?&type) (?> (?: (?&op_union) (?&type) )+ ) };
my $any_pattern
= q{ (?&type) | (?&union) };
my $defines = qr{(?(DEFINE)
(?<valid_chars> $valid_chars)
(?<type_atom> $type_atom)
(?<ws> $ws)
(?<op_union> $op_union)
(?<type> $type_pattern)
(?<type_capture_parts> $type_capture_parts_pattern)
(?<type_with_parameter> $type_with_parameter_pattern)
(?<union> $union_pattern)
(?<any> $any_pattern)
)}x;
$type = qr{ $type_pattern $defines }x;
$type_capture_parts = qr{ $type_capture_parts_pattern $defines }x;
$type_with_parameter = qr{ $type_with_parameter_pattern $defines }x;
$union = qr{ $union_pattern $defines }x;
$any = qr{ $any_pattern $defines }x;
}
else {
$type
= qr{ $type_atom (?: \[ $ws (??{$any}) $ws \] )? }x;
$type_capture_parts
= qr{ ($type_atom) (?: \[ $ws ((??{$any})) $ws \] )? }x;
$type_with_parameter
= qr{ $type_atom \[ $ws (??{$any}) $ws \] }x;
$union
= qr{ $type (?> (?: $op_union $type )+ ) }x;
$any
= qr{ $type | $union }x;
}
sub _parse_parameterized_type_constraint {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{ $type_capture_parts }x;
return ( $1, $2 );
}
sub _detect_parameterized_type_constraint {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{ ^ $type_with_parameter $ }x;
}
sub _parse_type_constraint_union {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
my $given = shift;
my @rv;
while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) {
push @rv => $1;
}
( pos($given) eq length($given) )
|| __PACKAGE__->_throw_error( "'$given' didn't parse (parse-pos="
. pos($given)
. " and str-length="
. length($given)
. ")" );
@rv;
}
sub _detect_type_constraint_union {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x;
}
}
## --------------------------------------------------------
# define some basic built-in types
## --------------------------------------------------------
# By making these classes immutable before creating all the types in
# Moose::Util::TypeConstraints::Builtin , we avoid repeatedly calling the slow
# MOP-based accessors.
$_->make_immutable(
inline_constructor => 1,
constructor_name => "_new",
# these are Class::MOP accessors, so they need inlining
inline_accessors => 1
) for grep { $_->is_mutable }
map { Class::MOP::class_of($_) }
qw(
Moose::Meta::TypeConstraint
Moose::Meta::TypeConstraint::Union
Moose::Meta::TypeConstraint::Parameterized
Moose::Meta::TypeConstraint::Parameterizable
Moose::Meta::TypeConstraint::Class
Moose::Meta::TypeConstraint::Role
Moose::Meta::TypeConstraint::Enum
Moose::Meta::TypeConstraint::DuckType
Moose::Meta::TypeConstraint::Registry
);
require Moose::Util::TypeConstraints::Builtins;
Moose::Util::TypeConstraints::Builtins::define_builtins($REGISTRY);
my @PARAMETERIZABLE_TYPES
= map { $REGISTRY->get_type_constraint($_) } qw[ScalarRef ArrayRef HashRef Maybe];
sub get_all_parameterizable_types {@PARAMETERIZABLE_TYPES}
sub add_parameterizable_type {
my $type = shift;
( blessed $type
&& $type->isa('Moose::Meta::TypeConstraint::Parameterizable') )
|| __PACKAGE__->_throw_error(
"Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"
);
push @PARAMETERIZABLE_TYPES => $type;
}
## --------------------------------------------------------
# end of built-in types ...
## --------------------------------------------------------
{
my @BUILTINS = list_all_type_constraints();
sub list_all_builtin_type_constraints {@BUILTINS}
}
sub _throw_error {
shift;
require Moose;
unshift @_, 'Moose';
goto &Moose::throw_error;
}
1;
# ABSTRACT: Type constraint system for Moose
=pod
=head1 NAME
Moose::Util::TypeConstraints - Type constraint system for Moose
=head1 VERSION
version 2.0401
=head1 SYNOPSIS
use Moose::Util::TypeConstraints;
subtype 'Natural',
as 'Int',
where { $_ > 0 };
subtype 'NaturalLessThanTen',
as 'Natural',
where { $_ < 10 },
message { "This number ($_) is not less than ten!" };
coerce 'Num',
from 'Str',
via { 0+$_ };
class_type 'DateTimeClass', { class => 'DateTime' };
role_type 'Barks', { role => 'Some::Library::Role::Barks' };
enum 'RGBColors', [qw(red green blue)];
union 'StringOrArray', [qw( String Array )];
no Moose::Util::TypeConstraints;
=head1 DESCRIPTION
This module provides Moose with the ability to create custom type
constraints to be used in attribute definition.
=head2 Important Caveat
This is B<NOT> a type system for Perl 5. These are type constraints,
and they are not used by Moose unless you tell it to. No type
inference is performed, expressions are not typed, etc. etc. etc.
A type constraint is at heart a small "check if a value is valid"
function. A constraint can be associated with an attribute. This
simplifies parameter validation, and makes your code clearer to read,
because you can refer to constraints by name.
=head2 Slightly Less Important Caveat
It is B<always> a good idea to quote your type names.
This prevents Perl from trying to execute the call as an indirect
object call. This can be an issue when you have a subtype with the
same name as a valid class.
For instance:
subtype DateTime => as Object => where { $_->isa('DateTime') };
will I<just work>, while this:
use DateTime;
subtype DateTime => as Object => where { $_->isa('DateTime') };
will fail silently and cause many headaches. The simple way to solve
this, as well as future proof your subtypes from classes which have
yet to have been created, is to quote the type name:
use DateTime;
subtype 'DateTime', as 'Object', where { $_->isa('DateTime') };
=head2 Default Type Constraints
This module also provides a simple hierarchy for Perl 5 types, here is
that hierarchy represented visually.
Any
Item
Bool
Maybe[`a]
Undef
Defined
Value
Str
Num
Int
ClassName
RoleName
Ref
ScalarRef[`a]
ArrayRef[`a]
HashRef[`a]
CodeRef
RegexpRef
GlobRef
FileHandle
Object
B<NOTE:> Any type followed by a type parameter C<[`a]> can be
parameterized, this means you can say:
ArrayRef[Int] # an array of integers
HashRef[CodeRef] # a hash of str to CODE ref mappings
ScalarRef[Int] # a reference to an integer
Maybe[Str] # value may be a string, may be undefined
If Moose finds a name in brackets that it does not recognize as an
existing type, it assumes that this is a class name, for example
C<ArrayRef[DateTime]>.
B<NOTE:> Unless you parameterize a type, then it is invalid to include
the square brackets. I.e. C<ArrayRef[]> will be treated as a new type
name, I<not> as a parameterization of C<ArrayRef>.
B<NOTE:> The C<Undef> type constraint for the most part works
correctly now, but edge cases may still exist, please use it
sparingly.
B<NOTE:> The C<ClassName> type constraint does a complex package
existence check. This means that your class B<must> be loaded for this
type constraint to pass.
B<NOTE:> The C<RoleName> constraint checks a string is a I<package
name> which is a role, like C<'MyApp::Role::Comparable'>.
=head2 Type Constraint Naming
Type name declared via this module can only contain alphanumeric
characters, colons (:), and periods (.).
Since the types created by this module are global, it is suggested
that you namespace your types just as you would namespace your
modules. So instead of creating a I<Color> type for your
B<My::Graphics> module, you would call the type
I<My::Graphics::Types::Color> instead.
=head2 Use with Other Constraint Modules
This module can play nicely with other constraint modules with some
slight tweaking. The C<where> clause in types is expected to be a
C<CODE> reference which checks its first argument and returns a
boolean. Since most constraint modules work in a similar way, it
should be simple to adapt them to work with Moose.
For instance, this is how you could use it with
L<Declare::Constraints::Simple> to declare a completely new type.
type 'HashOfArrayOfObjects',
where {
IsHashRef(
-keys => HasLength,
-values => IsArrayRef(IsObject)
)->(@_);
};
For more examples see the F<t/examples/example_w_DCS.t> test
file.
Here is an example of using L<Test::Deep> and its non-test
related C<eq_deeply> function.
type 'ArrayOfHashOfBarsAndRandomNumbers',
where {
eq_deeply($_,
array_each(subhashof({
bar => isa('Bar'),
random_number => ignore()
})))
};
For a complete example see the
F<t/examples/example_w_TestDeep.t> test file.
=head2 Error messages
Type constraints can also specify custom error messages, for when they fail to
validate. This is provided as just another coderef, which receives the invalid
value in C<$_>, as in:
subtype 'PositiveInt',
as 'Int',
where { $_ > 0 },
message { "$_ is not a positive integer!" };
If no message is specified, a default message will be used, which indicates
which type constraint was being used and what value failed. If
L<Devel::PartialDump> (version 0.14 or higher) is installed, it will be used to
display the invalid value, otherwise it will just be printed as is.
=head1 FUNCTIONS
=head2 Type Constraint Constructors
The following functions are used to create type constraints. They
will also register the type constraints your create in a global
registry that is used to look types up by name.
See the L</SYNOPSIS> for an example of how to use these.
=over 4
=item B<< subtype 'Name', as 'Parent', where { } ... >>
This creates a named subtype.
If you provide a parent that Moose does not recognize, it will
automatically create a new class type constraint for this name.
When creating a named type, the C<subtype> function should either be
called with the sugar helpers (C<where>, C<message>, etc), or with a
name and a hashref of parameters:
subtype( 'Foo', { where => ..., message => ... } );
The valid hashref keys are C<as> (the parent), C<where>, C<message>,
and C<optimize_as>.
=item B<< subtype as 'Parent', where { } ... >>
This creates an unnamed subtype and will return the type
constraint meta-object, which will be an instance of
L<Moose::Meta::TypeConstraint>.
When creating an anonymous type, the C<subtype> function should either
be called with the sugar helpers (C<where>, C<message>, etc), or with
just a hashref of parameters:
subtype( { where => ..., message => ... } );
=item B<class_type ($class, ?$options)>
Creates a new subtype of C<Object> with the name C<$class> and the
metaclass L<Moose::Meta::TypeConstraint::Class>.
# Create a type called 'Box' which tests for objects which ->isa('Box')
class_type 'Box';
By default, the name of the type and the name of the class are the same, but
you can specify both separately.
# Create a type called 'Box' which tests for objects which ->isa('ObjectLibrary::Box');
class_type 'Box', { class => 'ObjectLibrary::Box' };
=item B<role_type ($role, ?$options)>
Creates a C<Role> type constraint with the name C<$role> and the
metaclass L<Moose::Meta::TypeConstraint::Role>.
# Create a type called 'Walks' which tests for objects which ->does('Walks')
role_type 'Walks';
By default, the name of the type and the name of the role are the same, but
you can specify both separately.
# Create a type called 'Walks' which tests for objects which ->does('MooseX::Role::Walks');
role_type 'Walks', { role => 'MooseX::Role::Walks' };
=item B<maybe_type ($type)>
Creates a type constraint for either C<undef> or something of the
given type.
=item B<duck_type ($name, \@methods)>
This will create a subtype of Object and test to make sure the value
C<can()> do the methods in C<\@methods>.
This is intended as an easy way to accept non-Moose objects that
provide a certain interface. If you're using Moose classes, we
recommend that you use a C<requires>-only Role instead.
=item B<duck_type (\@methods)>
If passed an ARRAY reference as the only parameter instead of the
C<$name>, C<\@methods> pair, this will create an unnamed duck type.
This can be used in an attribute definition like so:
has 'cache' => (
is => 'ro',
isa => duck_type( [qw( get_set )] ),
);
=item B<enum ($name, \@values)>
This will create a basic subtype for a given set of strings.
The resulting constraint will be a subtype of C<Str> and
will match any of the items in C<\@values>. It is case sensitive.
See the L</SYNOPSIS> for a simple example.
B<NOTE:> This is not a true proper enum type, it is simply
a convenient constraint builder.
=item B<enum (\@values)>
If passed an ARRAY reference as the only parameter instead of the
C<$name>, C<\@values> pair, this will create an unnamed enum. This
can then be used in an attribute definition like so:
has 'sort_order' => (
is => 'ro',
isa => enum([qw[ ascending descending ]]),
);
=item B<union ($name, \@constraints)>
This will create a basic subtype where any of the provided constraints
may match in order to satisfy this constraint.
=item B<union (\@constraints)>
If passed an ARRAY reference as the only parameter instead of the
C<$name>, C<\@constraints> pair, this will create an unnamed union.
This can then be used in an attribute definition like so:
has 'items' => (
is => 'ro',
isa => union([qw[ Str ArrayRef ]]),
);
This is similar to the existing string union:
isa => 'Str|ArrayRef'
except that it supports anonymous elements as child constraints:
has 'color' => (
isa => 'ro',
isa => union([ 'Int', enum([qw[ red green blue ]]) ]),
);
=item B<as 'Parent'>
This is just sugar for the type constraint construction syntax.
It takes a single argument, which is the name of a parent type.
=item B<where { ... }>
This is just sugar for the type constraint construction syntax.
It takes a subroutine reference as an argument. When the type
constraint is tested, the reference is run with the value to be tested
in C<$_>. This reference should return true or false to indicate
whether or not the constraint check passed.
=item B<message { ... }>
This is just sugar for the type constraint construction syntax.
It takes a subroutine reference as an argument. When the type
constraint fails, then the code block is run with the value provided
in C<$_>. This reference should return a string, which will be used in
the text of the exception thrown.
=item B<inline_as { ... }>
This can be used to define a "hand optimized" inlinable version of your type
constraint.
You provide a subroutine which will be called I<as a method> on a
L<Moose::Meta::TypeConstraint> object. It will receive a single parameter, the
name of the variable to check, typically something like C<"$_"> or C<"$_[0]">.
The subroutine should return a code string suitable for inlining. You can
assume that the check will be wrapped in parentheses when it is inlined.
The inlined code should include any checks that your type's parent types
do. If your parent type constraint defines its own inlining, you can simply use
that to avoid repeating code. For example, here is the inlining code for the
C<Value> type, which is a subtype of C<Defined>:
sub {
$_[0]->parent()->_inline_check($_[1])
. ' && !ref(' . $_[1] . ')'
}
=item B<optimize_as { ... }>
B<This feature is deprecated, use C<inline_as> instead.>
This can be used to define a "hand optimized" version of your
type constraint which can be used to avoid traversing a subtype
constraint hierarchy.
B<NOTE:> You should only use this if you know what you are doing.
All the built in types use this, so your subtypes (assuming they
are shallow) will not likely need to use this.
=item B<< type 'Name', where { } ... >>
This creates a base type, which has no parent.
The C<type> function should either be called with the sugar helpers
(C<where>, C<message>, etc), or with a name and a hashref of
parameters:
type( 'Foo', { where => ..., message => ... } );
The valid hashref keys are C<where>, C<message>, and C<inlined_as>.
=back
=head2 Type Constraint Utilities
=over 4
=item B<< match_on_type $value => ( $type => \&action, ... ?\&default ) >>
This is a utility function for doing simple type based dispatching similar to
match/case in OCaml and case/of in Haskell. It is not as featureful as those
languages, nor does not it support any kind of automatic destructuring
bind. Here is a simple Perl pretty printer dispatching over the core Moose
types.
sub ppprint {
my $x = shift;
match_on_type $x => (
HashRef => sub {
my $hash = shift;
'{ '
. (
join ", " => map { $_ . ' => ' . ppprint( $hash->{$_} ) }
sort keys %$hash
) . ' }';
},
ArrayRef => sub {
my $array = shift;
'[ ' . ( join ", " => map { ppprint($_) } @$array ) . ' ]';
},
CodeRef => sub {'sub { ... }'},
RegexpRef => sub { 'qr/' . $_ . '/' },
GlobRef => sub { '*' . B::svref_2object($_)->NAME },
Object => sub { $_->can('to_string') ? $_->to_string : $_ },
ScalarRef => sub { '\\' . ppprint( ${$_} ) },
Num => sub {$_},
Str => sub { '"' . $_ . '"' },
Undef => sub {'undef'},
=> sub { die "I don't know what $_ is" }
);
}
Or a simple JSON serializer:
sub to_json {
my $x = shift;
match_on_type $x => (
HashRef => sub {
my $hash = shift;
'{ '
. (
join ", " =>
map { '"' . $_ . '" : ' . to_json( $hash->{$_} ) }
sort keys %$hash
) . ' }';
},
ArrayRef => sub {
my $array = shift;
'[ ' . ( join ", " => map { to_json($_) } @$array ) . ' ]';
},
Num => sub {$_},
Str => sub { '"' . $_ . '"' },
Undef => sub {'null'},
=> sub { die "$_ is not acceptable json type" }
);
}
The matcher is done by mapping a C<$type> to an C<\&action>. The C<$type> can
be either a string type or a L<Moose::Meta::TypeConstraint> object, and
C<\&action> is a subroutine reference. This function will dispatch on the
first match for C<$value>. It is possible to have a catch-all by providing an
additional subroutine reference as the final argument to C<match_on_type>.
=back
=head2 Type Coercion Constructors
You can define coercions for type constraints, which allow you to
automatically transform values to something valid for the type
constraint. If you ask your accessor to coerce, then Moose will run
the type-coercion code first, followed by the type constraint
check. This feature should be used carefully as it is very powerful
and could easily take off a limb if you are not careful.
See the L</SYNOPSIS> for an example of how to use these.
=over 4
=item B<< coerce 'Name', from 'OtherName', via { ... } >>
This defines a coercion from one type to another. The C<Name> argument
is the type you are coercing I<to>.
To define multiple coercions, supply more sets of from/via pairs:
coerce 'Name',
from 'OtherName', via { ... },
from 'ThirdName', via { ... };
=item B<from 'OtherName'>
This is just sugar for the type coercion construction syntax.
It takes a single type name (or type object), which is the type being
coerced I<from>.
=item B<via { ... }>
This is just sugar for the type coercion construction syntax.
It takes a subroutine reference. This reference will be called with
the value to be coerced in C<$_>. It is expected to return a new value
of the proper type for the coercion.
=back
=head2 Creating and Finding Type Constraints
These are additional functions for creating and finding type
constraints. Most of these functions are not available for
importing. The ones that are importable as specified.
=over 4
=item B<find_type_constraint($type_name)>
This function can be used to locate the L<Moose::Meta::TypeConstraint>
object for a named type.
This function is importable.
=item B<register_type_constraint($type_object)>
This function will register a L<Moose::Meta::TypeConstraint> with the
global type registry.
This function is importable.
=item B<normalize_type_constraint_name($type_constraint_name)>
This method takes a type constraint name and returns the normalized
form. This removes any whitespace in the string.
=item B<create_type_constraint_union($pipe_separated_types | @type_constraint_names)>
=item B<create_named_type_constraint_union($name, $pipe_separated_types | @type_constraint_names)>
This can take a union type specification like C<'Int|ArrayRef[Int]'>,
or a list of names. It returns a new
L<Moose::Meta::TypeConstraint::Union> object.
=item B<create_parameterized_type_constraint($type_name)>
Given a C<$type_name> in the form of C<'BaseType[ContainerType]'>,
this will create a new L<Moose::Meta::TypeConstraint::Parameterized>
object. The C<BaseType> must exist already exist as a parameterizable
type.
=item B<create_class_type_constraint($class, $options)>
Given a class name this function will create a new
L<Moose::Meta::TypeConstraint::Class> object for that class name.
The C<$options> is a hash reference that will be passed to the
L<Moose::Meta::TypeConstraint::Class> constructor (as a hash).
=item B<create_role_type_constraint($role, $options)>
Given a role name this function will create a new
L<Moose::Meta::TypeConstraint::Role> object for that role name.
The C<$options> is a hash reference that will be passed to the
L<Moose::Meta::TypeConstraint::Role> constructor (as a hash).
=item B<create_enum_type_constraint($name, $values)>
Given a enum name this function will create a new
L<Moose::Meta::TypeConstraint::Enum> object for that enum name.
=item B<create_duck_type_constraint($name, $methods)>
Given a duck type name this function will create a new
L<Moose::Meta::TypeConstraint::DuckType> object for that enum name.
=item B<find_or_parse_type_constraint($type_name)>
Given a type name, this first attempts to find a matching constraint
in the global registry.
If the type name is a union or parameterized type, it will create a
new object of the appropriate, but if given a "regular" type that does
not yet exist, it simply returns false.
When given a union or parameterized type, the member or base type must
already exist.
If it creates a new union or parameterized type, it will add it to the
global registry.
=item B<find_or_create_isa_type_constraint($type_name)>
=item B<find_or_create_does_type_constraint($type_name)>
These functions will first call C<find_or_parse_type_constraint>. If
that function does not return a type, a new type object will
be created.
The C<isa> variant will use C<create_class_type_constraint> and the
C<does> variant will use C<create_role_type_constraint>.
=item B<get_type_constraint_registry>
Returns the L<Moose::Meta::TypeConstraint::Registry> object which
keeps track of all type constraints.
=item B<list_all_type_constraints>
This will return a list of type constraint names in the global
registry. You can then fetch the actual type object using
C<find_type_constraint($type_name)>.
=item B<list_all_builtin_type_constraints>
This will return a list of builtin type constraints, meaning those
which are defined in this module. See the L<Default Type Constraints>
section for a complete list.
=item B<export_type_constraints_as_functions>
This will export all the current type constraints as functions into
the caller's namespace (C<Int()>, C<Str()>, etc). Right now, this is
mostly used for testing, but it might prove useful to others.
=item B<get_all_parameterizable_types>
This returns all the parameterizable types that have been registered,
as a list of type objects.
=item B<add_parameterizable_type($type)>
Adds C<$type> to the list of parameterizable types
=back
=head1 BUGS
See L<Moose/BUGS> for details on reporting bugs.
=head1 AUTHOR
Moose is maintained by the Moose Cabal, along with the help of many contributors. See L<Moose/CABAL> and L<Moose/CONTRIBUTORS> for details.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Infinity Interactive, Inc..
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
|