X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FUtil%2FTypeConstraints.pm;h=855bd001dc1dfac039f73e4ce5bfe4b1a8ee2130;hb=b2ad68e3fbe4016e354980a636c1ed39e941162a;hp=93232242c58625b36e5ac07797590a721e37007c;hpb=9c27968f4e8cfd8bff0dbca35c419b733a689d75;p=gitmo%2FMoose.git diff --git a/lib/Moose/Util/TypeConstraints.pm b/lib/Moose/Util/TypeConstraints.pm index 9323224..855bd00 100644 --- a/lib/Moose/Util/TypeConstraints.pm +++ b/lib/Moose/Util/TypeConstraints.pm @@ -5,10 +5,11 @@ use strict; use warnings; use Carp (); +use List::MoreUtils qw( all ); use Scalar::Util 'blessed'; use Moose::Exporter; -our $VERSION = '0.57'; +our $VERSION = '0.67'; $VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; @@ -46,7 +47,8 @@ use Moose::Util::TypeConstraints::OptimizedConstraints; Moose::Exporter->setup_import_methods( as_is => [ qw( - type subtype class_type role_type as where message optimize_as + type subtype class_type role_type maybe_type + as where message optimize_as coerce from via enum find_type_constraint @@ -83,13 +85,13 @@ sub create_type_constraint_union { } (scalar @type_constraint_names >= 2) - || Moose->throw_error("You must pass in at least 2 type names to make a union"); + || __PACKAGE__->_throw_error("You must pass in at least 2 type names to make a union"); - my @type_constraints = sort {$a->name cmp $b->name} map { + my @type_constraints = map { find_or_parse_type_constraint($_) || - Moose->throw_error("Could not locate type constraint ($_) for the union"); + __PACKAGE__->_throw_error("Could not locate type constraint ($_) for the union"); } @type_constraint_names; - + return Moose::Meta::TypeConstraint::Union->new( type_constraints => \@type_constraints ); @@ -100,16 +102,16 @@ sub create_parameterized_type_constraint { my ($base_type, $type_parameter) = _parse_parameterized_type_constraint($type_constraint_name); (defined $base_type && defined $type_parameter) - || Moose->throw_error("Could not parse type name ($type_constraint_name) correctly"); + || __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, + $type_parameter ); } else { - Moose->throw_error("Could not locate the base type ($base_type)"); + __PACKAGE__->_throw_error("Could not locate the base type ($base_type)"); } } @@ -117,16 +119,14 @@ 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 { + } else { return Moose::Meta::TypeConstraint::Parameterized->new( - name => $base_type_tc->name . '[' . $type_parameter . ']', + name => $base_type_tc->name . '[' . $type_parameter . ']', parent => $base_type_tc, - type_parameter => - find_or_create_isa_type_constraint($type_parameter), + type_parameter => find_or_create_isa_type_constraint($type_parameter), ); } -} +} #should we also support optimized checks? sub create_class_type_constraint { @@ -134,7 +134,7 @@ sub create_class_type_constraint { # too early for this check #find_type_constraint("ClassName")->check($class) - # || Moose->throw_error("Can't create a class type constraint because '$class' is not a class name"); + # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); my %options = ( class => $class, @@ -152,7 +152,7 @@ sub create_role_type_constraint { # too early for this check #find_type_constraint("ClassName")->check($class) - # || Moose->throw_error("Can't create a class type constraint because '$class' is not a class name"); + # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); my %options = ( role => $role, @@ -222,11 +222,18 @@ sub find_or_parse_type_constraint { } sub normalize_type_constraint_name { - my $type_constraint_name = shift @_; + 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 ... ## -------------------------------------------------------- @@ -245,7 +252,7 @@ sub find_type_constraint { sub register_type_constraint { my $constraint = shift; - Moose->throw_error("can't register an unnamed type constraint") unless defined $constraint->name; + __PACKAGE__->_throw_error("can't register an unnamed type constraint") unless defined $constraint->name; $REGISTRY->add_type_constraint($constraint); return $constraint; } @@ -262,12 +269,18 @@ sub subtype { # this adds an undef for the name # if this is an anon-subtype: # subtype(Num => where { $_ % 2 == 0 }) # anon 'even' subtype - # but if the last arg is not a code - # ref then it is a subtype alias: + # or + # subtype(Num => where { $_ % 2 == 0 }) message { "$_ must be an even number" } + # + # but if the last arg is not a code ref then it is a subtype + # alias: + # # subtype(MyNumbers => as Num); # now MyNumbers is the same as Num # ... yeah I know it's ugly code # - SL - unshift @_ => undef if scalar @_ <= 2 && ('CODE' eq ref($_[1])); + unshift @_ => undef if scalar @_ == 2 && ( 'CODE' eq ref( $_[-1] ) ); + unshift @_ => undef + if scalar @_ == 3 && all { ref($_) =~ /^(?:CODE|HASH)$/ } @_[ 1, 2 ]; goto &_create_type_constraint; } @@ -289,6 +302,14 @@ sub role_type ($;$) { ); } +sub maybe_type { + my ($type_parameter) = @_; + + register_type_constraint( + $REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter) + ); +} + sub coerce { my ($type_name, @coercion_map) = @_; _install_type_coercions($type_name, \@coercion_map); @@ -313,7 +334,7 @@ sub enum { $type_name = undef; } (scalar @values >= 2) - || Moose->throw_error("You must have at least two values to enumerate through"); + || __PACKAGE__->_throw_error("You must have at least two values to enumerate through"); my %valid = map { $_ => 1 } @values; register_type_constraint( @@ -342,55 +363,48 @@ sub _create_type_constraint ($$$;$$) { my $parent = shift; my $check = shift; - my ($message, $optimized); + my ( $message, $optimized ); for (@_) { $message = $_->{message} if exists $_->{message}; $optimized = $_->{optimized} if exists $_->{optimized}; } - my $pkg_defined_in = scalar(caller(0)); + my $pkg_defined_in = scalar( caller(0) ); - if (defined $name) { + 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; + ( $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 $class = "Moose::Meta::TypeConstraint"; - - # FIXME should probably not be a special case - if ( defined $parent and $parent = find_or_parse_type_constraint($parent) ) { - $class = "Moose::Meta::TypeConstraint::Parameterizable" - if $parent->isa("Moose::Meta::TypeConstraint::Parameterizable"); - } - - my $constraint = $class->new( - name => $name || '__ANON__', + my %opts = ( + name => $name, package_defined_in => $pkg_defined_in, - ($parent ? (parent => $parent ) : ()), - ($check ? (constraint => $check) : ()), - ($message ? (message => $message) : ()), - ($optimized ? (optimized => $optimized) : ()), + ( $check ? ( constraint => $check ) : () ), + ( $message ? ( message => $message ) : () ), + ( $optimized ? ( optimized => $optimized ) : () ), ); - # NOTE: - # if we have a type constraint union, and no - # type check, this means we are just aliasing - # the union constraint, which means we need to - # handle this differently. - # - SL - if (not(defined $check) - && $parent->isa('Moose::Meta::TypeConstraint::Union') - && $parent->has_coercion - ){ - $constraint->coercion(Moose::Meta::TypeCoercion::Union->new( - type_constraint => $parent - )); + 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) @@ -403,7 +417,7 @@ sub _install_type_coercions ($$) { my ($type_name, $coercion_map) = @_; my $type = find_type_constraint($type_name); (defined $type) - || Moose->throw_error("Cannot find type '$type_name', perhaps you forgot to load it."); + || __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); } @@ -429,31 +443,24 @@ sub _install_type_coercions ($$) { use re "eval"; - my $valid_chars = qr{[\w:]}; + my $valid_chars = qr{[\w:\.]}; my $type_atom = qr{ $valid_chars+ }; my $any; - my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x; + my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x; my $type_capture_parts = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x; - my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x; + my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x; my $op_union = qr{ \s* \| \s* }x; my $union = qr{ $type (?: $op_union $type )+ }x; - ## New Stuff for structured types. - my $comma = qr{,}; - my $indirection = qr{=>}; - my $divider_ops = qr{ $comma | $indirection }x; - my $structure_divider = qr{\s* $divider_ops \s*}x; - my $structure_elements = qr{ ($type $structure_divider*)+ }x; - - $any = qr{ $type | $union | $structure_elements }x; + $any = qr{ $type | $union }x; sub _parse_parameterized_type_constraint { { no warnings 'void'; $any; } # force capture of interpolated lexical - my($base, $elements) = ($_[0] =~ m{ $type_capture_parts }x); - return ($base,$elements); + $_[0] =~ m{ $type_capture_parts }x; + return ($1, $2); } sub _detect_parameterized_type_constraint { @@ -469,7 +476,7 @@ sub _install_type_coercions ($$) { push @rv => $1; } (pos($given) eq length($given)) - || Moose->throw_error("'$given' didn't parse (parse-pos=" + || __PACKAGE__->_throw_error("'$given' didn't parse (parse-pos=" . pos($given) . " and str-length=" . length($given) @@ -487,6 +494,27 @@ sub _install_type_coercions ($$) { # define some basic built-in types ## -------------------------------------------------------- +# By making these classes immutable before creating all the types we +# below, 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 { $_->meta } + 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::Registry +); + type 'Any' => where { 1 }; # meta-type including all type 'Item' => where { 1 }; # base-type @@ -621,7 +649,7 @@ sub get_all_parameterizable_types { @PARAMETERIZABLE_TYPES } sub add_parameterizable_type { my $type = shift; (blessed $type && $type->isa('Moose::Meta::TypeConstraint::Parameterizable')) - || Moose->throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"); + || __PACKAGE__->_throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"); push @PARAMETERIZABLE_TYPES => $type; } @@ -634,6 +662,12 @@ sub add_parameterizable_type { sub list_all_builtin_type_constraints { @BUILTINS } } +sub _throw_error { + require Moose; + unshift @_, 'Moose'; + goto &Moose::throw_error; +} + 1; __END__ @@ -730,15 +764,19 @@ that hierarchy represented visually. GlobRef FileHandle Object - Role + Role B Any type followed by a type parameter C<[`a]> can be parameterized, this means you can say: - ArrayRef[Int] # an array of intergers + ArrayRef[Int] # an array of integers HashRef[CodeRef] # a hash of str to CODE ref mappings 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. + B Unless you parameterize a type, then it is invalid to include the square brackets. I.e. C will be literally interpreted as a type name. @@ -754,10 +792,13 @@ but it is a saner restriction than most others. =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 type for your B -module, you would call the type I instead. +module, you would call the type I instead. =head2 Use with Other Constraint Modules @@ -814,6 +855,9 @@ This creates a base type, which has no parent. 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. + =item B This creates an unnamed subtype and will return the type @@ -830,6 +874,11 @@ L. Creates a type constraint with the name C<$role> and the metaclass L. +=item B + +Creates a type constraint for either C or something of the +given type. + =item B This will create a basic subtype for a given set of strings. @@ -965,7 +1014,7 @@ C. =item B -Attempts to parse the type name using L and if +Attempts to parse the type name using C and if no appropriate constraint is found will create a new anonymous one. The C variant will use C and the C @@ -1014,17 +1063,6 @@ Adds C<$type> to the list of parameterizable types =back -=head1 Error Management - -=over 4 - -=item B - -If the caller is a Moose metaclass, use its L -routine, otherwise use L. - -=back - =head2 Namespace Management =over 4 @@ -1048,7 +1086,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006-2008 by Infinity Interactive, Inc. +Copyright 2006-2009 by Infinity Interactive, Inc. L