X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FUtil%2FTypeConstraints.pm;h=d1b68fa974460b7ae92fe4431235b83b74d9835e;hp=c6f7b175ae8846aff8c13ec4a8e7a9c6f18c22de;hb=4bc73e4760435ee34876be28bf4522e9e7eaf519;hpb=065f79e7cd03765f26c6ea276aaf9b3c5897886a diff --git a/lib/Mouse/Util/TypeConstraints.pm b/lib/Mouse/Util/TypeConstraints.pm index c6f7b17..d1b68fa 100644 --- a/lib/Mouse/Util/TypeConstraints.pm +++ b/lib/Mouse/Util/TypeConstraints.pm @@ -11,13 +11,75 @@ Mouse::Exporter->setup_import_methods( as_is => [qw( as where message optimize_as from via - type subtype coerce class_type role_type enum + + type subtype class_type role_type duck_type + enum + coerce + find_type_constraint )], ); my %TYPE; +# The root type +$TYPE{Any} = Mouse::Meta::TypeConstraint->new( + name => 'Any', +); + +my @builtins = ( + # $name => $parent, $code, + + # the base type + Item => 'Any', undef, + + # the maybe[] type + Maybe => 'Item', undef, + + # value types + Undef => 'Item', \&Undef, + Defined => 'Item', \&Defined, + Bool => 'Item', \&Bool, + Value => 'Defined', \&Value, + Str => 'Value', \&Str, + Num => 'Str', \&Num, + Int => 'Num', \&Int, + + # ref types + Ref => 'Defined', \&Ref, + ScalarRef => 'Ref', \&ScalarRef, + ArrayRef => 'Ref', \&ArrayRef, + HashRef => 'Ref', \&HashRef, + CodeRef => 'Ref', \&CodeRef, + RegexpRef => 'Ref', \&RegexpRef, + GlobRef => 'Ref', \&GlobRef, + + # object types + FileHandle => 'GlobRef', \&FileHandle, + Object => 'Ref', \&Object, + + # special string types + ClassName => 'Str', \&ClassName, + RoleName => 'ClassName', \&RoleName, +); + + +while (my ($name, $parent, $code) = splice @builtins, 0, 3) { + $TYPE{$name} = Mouse::Meta::TypeConstraint->new( + name => $name, + parent => $TYPE{$parent}, + optimized => $code, + ); +} + +# make it parametarizable + +$TYPE{Maybe} {constraint_generator} = \&_parameterize_Maybe_for; +$TYPE{ArrayRef}{constraint_generator} = \&_parameterize_ArrayRef_for; +$TYPE{HashRef} {constraint_generator} = \&_parameterize_HashRef_for; + +# sugars + sub as ($) { (as => $_[0]) } sub where (&) { (where => $_[0]) } sub message (&) { (message => $_[0]) } @@ -26,60 +88,18 @@ sub optimize_as (&) { (optimize_as => $_[0]) } sub from { @_ } sub via (&) { $_[0] } -BEGIN { - my %builtins = ( - Any => undef, # null check - Item => undef, # null check - Maybe => undef, # null check - - Bool => \&Bool, - Undef => \&Undef, - Defined => \&Defined, - Value => \&Value, - Num => \&Num, - Int => \&Int, - Str => \&Str, - Ref => \&Ref, - - ScalarRef => \&ScalarRef, - ArrayRef => \&ArrayRef, - HashRef => \&HashRef, - CodeRef => \&CodeRef, - RegexpRef => \&RegexpRef, - GlobRef => \&GlobRef, - - FileHandle => \&FileHandle, - - Object => \&Object, - - ClassName => \&ClassName, - RoleName => \&RoleName, - ); - - while (my ($name, $code) = each %builtins) { - $TYPE{$name} = Mouse::Meta::TypeConstraint->new( - name => $name, - optimized => $code, - ); - } - - sub optimized_constraints { # DEPRECATED - Carp::cluck('optimized_constraints() has been deprecated'); - return \%TYPE; - } - - my @builtins = keys %TYPE; - sub list_all_builtin_type_constraints { @builtins } +# type utilities - sub list_all_type_constraints { keys %TYPE } +sub optimized_constraints { # DEPRECATED + Carp::cluck('optimized_constraints() has been deprecated'); + return \%TYPE; } -# is-a predicates -BEGIN{ - _generate_class_type_for('Mouse::Meta::TypeConstraint' => '_is_a_type_constraint'); - _generate_class_type_for('Mouse::Meta::Class' => '_is_a_metaclass'); - _generate_class_type_for('Mouse::Meta::Role' => '_is_a_metarole'); -} +undef @builtins; # free the allocated memory +@builtins = keys %TYPE; # reuse it +sub list_all_builtin_type_constraints { @builtins } + +sub list_all_type_constraints { keys %TYPE } sub _create_type{ @@ -103,9 +123,7 @@ sub _create_type{ } if(!defined $name){ - if(!defined($name = $args{name})){ - $name = '__ANON__'; - } + $name = $args{name}; } $args{name} = $name; @@ -114,16 +132,29 @@ sub _create_type{ $parent = delete $args{as}; if(!$parent){ $parent = delete $args{name}; - $name = '__ANON__'; + $name = undef; } } - my $package_defined_in = $args{package_defined_in} ||= caller(1); + if(defined $name){ + # set 'package_defined_in' only if it is not a core package + my $this = $args{package_defined_in}; + if(!$this){ + $this = caller(1); + if($this !~ /\A Mouse \b/xms){ + $args{package_defined_in} = $this; + } + } - my $existing = $TYPE{$name}; - if($existing && $existing->{package_defined_in} ne $package_defined_in){ - confess("The type constraint '$name' has already been created in " - . "$existing->{package_defined_in} and cannot be created again in $package_defined_in"); + if($TYPE{$name}){ + my $that = $TYPE{$name}->{package_defined_in} || __PACKAGE__; + ($this eq $that) or confess( + "The type constraint '$name' has already been created in $that and cannot be created again in $this" + ); + } + } + else{ + $args{name} = '__ANON__'; } $args{constraint} = delete $args{where} if exists $args{where}; @@ -137,7 +168,12 @@ sub _create_type{ $constraint = Mouse::Meta::TypeConstraint->new(%args); } - return $TYPE{$name} = $constraint; + if(defined $name){ + return $TYPE{$name} = $constraint; + } + else{ + return $constraint; + } } sub type { @@ -161,51 +197,52 @@ sub coerce { sub class_type { my($name, $options) = @_; my $class = $options->{class} || $name; + + # ClassType return _create_type 'subtype', $name => ( as => 'Object', - optimized_as => _generate_class_type_for($class), - - type => 'Class', + optimized_as => Mouse::Util::generate_isa_predicate_for($class), ); } sub role_type { my($name, $options) = @_; my $role = $options->{role} || $name; + + # RoleType return _create_type 'subtype', $name => ( as => 'Object', optimized_as => sub { Scalar::Util::blessed($_[0]) && does_role($_[0], $role) }, - - type => 'Role', ); } -sub typecast_constraints { # DEPRECATED - my($class, $pkg, $type, $value) = @_; - Carp::croak("wrong arguments count") unless @_ == 4; +sub duck_type { + my($name, @methods); - Carp::cluck("typecast_constraints() has been deprecated, which was an internal utility anyway"); + if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){ + $name = shift; + } + + @methods = (@_ == 1 && ref($_[0]) eq 'ARRAY') ? @{$_[0]} : @_; - return $type->coerce($value); + # DuckType + return _create_type 'type', $name => ( + optimized_as => Mouse::Util::generate_can_predicate_for(\@methods), + ); } sub enum { my($name, %valid); - # enum ['small', 'medium', 'large'] - if (ref($_[0]) eq 'ARRAY') { - %valid = map{ $_ => undef } @{ $_[0] }; - $name = sprintf '(%s)', join '|', sort @{$_[0]}; - } - # enum size => 'small', 'medium', 'large' - else{ - $name = shift; - %valid = map{ $_ => undef } @_; + if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){ + $name = shift; } + + %valid = map{ $_ => undef } (@_ == 1 && ref($_[0]) eq 'ARRAY' ? @{$_[0]} : @_); + + # EnumType return _create_type 'type', $name => ( optimized_as => sub{ defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]} }, - - type => 'Enum', ); } @@ -217,7 +254,7 @@ sub _find_or_create_regular_type{ my $meta = Mouse::Util::get_metaclass_by_name($spec) or return undef; - if(_is_a_metarole($meta)){ + if(Mouse::Util::is_a_metarole($meta)){ return role_type($spec); } else{ @@ -225,73 +262,24 @@ sub _find_or_create_regular_type{ } } -$TYPE{ArrayRef}{constraint_generator} = sub { - my($type_parameter) = @_; - my $check = $type_parameter->_compiled_type_constraint; - - return sub{ - foreach my $value (@{$_}) { - return undef unless $check->($value); - } - return 1; - } -}; -$TYPE{HashRef}{constraint_generator} = sub { - my($type_parameter) = @_; - my $check = $type_parameter->_compiled_type_constraint; - - return sub{ - foreach my $value(values %{$_}){ - return undef unless $check->($value); - } - return 1; - }; -}; - -# 'Maybe' type accepts 'Any', so it requires parameters -$TYPE{Maybe}{constraint_generator} = sub { - my($type_parameter) = @_; - my $check = $type_parameter->_compiled_type_constraint; - - return sub{ - return !defined($_) || $check->($_); - }; -}; - sub _find_or_create_parameterized_type{ my($base, $param) = @_; my $name = sprintf '%s[%s]', $base->name, $param->name; - $TYPE{$name} ||= do{ - my $generator = $base->{constraint_generator}; - - if(!$generator){ - confess("The $name constraint cannot be used, because $param doesn't subtype from a parameterizable type"); - } - - Mouse::Meta::TypeConstraint->new( - name => $name, - parent => $base, - constraint => $generator->($param), - - type => 'Parameterized', - ); - } + $TYPE{$name} ||= $base->parameterize($param, $name); } + sub _find_or_create_union_type{ - my @types = sort{ $a cmp $b } map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_; + my @types = sort map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_; my $name = join '|', @types; - $TYPE{$name} ||= do{ - return Mouse::Meta::TypeConstraint->new( - name => $name, - type_constraints => \@types, - - type => 'Union', - ); - }; + # UnionType + $TYPE{$name} ||= Mouse::Meta::TypeConstraint->new( + name => $name, + type_constraints => \@types, + ); } # The type parser @@ -366,7 +354,8 @@ sub _parse_type{ sub find_type_constraint { my($spec) = @_; - return $spec if _is_a_type_constraint($spec); + return $spec if Mouse::Util::is_a_type_constraint($spec); + return undef if !defined $spec; $spec =~ s/\s+//g; return $TYPE{$spec}; @@ -374,7 +363,8 @@ sub find_type_constraint { sub find_or_parse_type_constraint { my($spec) = @_; - return $spec if _is_a_type_constraint($spec); + return $spec if Mouse::Util::is_a_type_constraint($spec); + return undef if !defined $spec; $spec =~ s/\s+//g; return $TYPE{$spec} || do{ @@ -394,7 +384,6 @@ sub find_or_create_isa_type_constraint { } 1; - __END__ =head1 NAME @@ -403,7 +392,7 @@ Mouse::Util::TypeConstraints - Type constraint system for Mouse =head1 VERSION -This document describes Mouse version 0.40_02 +This document describes Mouse version 0.50_03 =head2 SYNOPSIS @@ -471,18 +460,18 @@ yet to have been created, is to quote the type name: This module also provides a simple hierarchy for Perl 5 types, here is that hierarchy represented visually. - Any + Any Item Bool Maybe[`a] Undef Defined Value - Num - Int Str - ClassName - RoleName + Num + Int + ClassName + RoleName Ref ScalarRef ArrayRef[`a] @@ -490,7 +479,7 @@ that hierarchy represented visually. CodeRef RegexpRef GlobRef - FileHandle + FileHandle Object B Any type followed by a type parameter C<[`a]> can be @@ -576,16 +565,26 @@ Returns the names of all the type constraints. =over 4 -=item C<< subtype 'Name' => as 'Parent' => where { } ... -> Mouse::Meta::TypeConstraint >> +=item C<< type $name => where { } ... -> Mouse::Meta::TypeConstraint >> + +=item C<< subtype $name => as $parent => where { } ... -> Mouse::Meta::TypeConstraint >> -=item C<< subtype as 'Parent' => where { } ... -> Mouse::Meta::TypeConstraint >> +=item C<< subtype as $parent => where { } ... -> Mouse::Meta::TypeConstraint >> =item C<< class_type ($class, ?$options) -> Mouse::Meta::TypeConstraint >> =item C<< role_type ($role, ?$options) -> Mouse::Meta::TypeConstraint >> +=item C<< duck_type($name, @methods | \@methods) -> Mouse::Meta::TypeConstraint >> + +=item C<< duck_type(\@methods) -> Mouse::Meta::TypeConstraint >> + +=item C<< enum($name, @values | \@values) -> Mouse::Meta::TypeConstraint >> + =item C<< enum (\@values) -> Mouse::Meta::TypeConstraint >> +=item C<< coerce $type => from $another_type, via { }, ... >> + =back =over 4