X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMouse%2FUtil%2FTypeConstraints.pm;h=f76b249d6e54ed2bf32e3a631d54469c6bc82e55;hb=dbf2d5d48aa00b6b2a98dc788d6c3323ab760aee;hp=d06122d40d069dcd1f8070168d9698801ca08918;hpb=c2168931940aa681120ba25c60658fe33c42cc1d;p=gitmo%2FMouse.git diff --git a/lib/Mouse/Util/TypeConstraints.pm b/lib/Mouse/Util/TypeConstraints.pm index d06122d..f76b249 100644 --- a/lib/Mouse/Util/TypeConstraints.pm +++ b/lib/Mouse/Util/TypeConstraints.pm @@ -1,12 +1,12 @@ package Mouse::Util::TypeConstraints; -use Mouse::Util qw(does_role not_supported); # enables strict and warnings - -use Carp qw(confess); -use Scalar::Util (); +use Mouse::Util; # enables strict and warnings use Mouse::Meta::TypeConstraint; use Mouse::Exporter; +use Carp (); +use Scalar::Util (); + Mouse::Exporter->setup_import_methods( as_is => [qw( as where message optimize_as @@ -17,9 +17,12 @@ Mouse::Exporter->setup_import_methods( coerce find_type_constraint + register_type_constraint )], ); +our @CARP_NOT = qw(Mouse::Meta::Attribute); + my %TYPE; # The root type @@ -63,7 +66,6 @@ my @builtins = ( RoleName => 'ClassName', \&RoleName, ); - while (my ($name, $parent, $code) = splice @builtins, 0, 3) { $TYPE{$name} = Mouse::Meta::TypeConstraint->new( name => $name, @@ -72,21 +74,19 @@ while (my ($name, $parent, $code) = splice @builtins, 0, 3) { ); } -# make it parametarizable - +# parametarizable types $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]) } -sub optimize_as (&) { (optimize_as => $_[0]) } +sub as ($) { (as => $_[0]) } ## no critic +sub where (&) { (where => $_[0]) } ## no critic +sub message (&) { (message => $_[0]) } ## no critic +sub optimize_as (&) { (optimize_as => $_[0]) } ## no critic sub from { @_ } -sub via (&) { $_[0] } +sub via (&) { $_[0] } ## no critic # type utilities @@ -98,26 +98,24 @@ sub optimized_constraints { # DEPRECATED 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{ - my $mode = shift; - +sub _define_type { + my $is_subtype = shift; my $name; my %args; - if(@_ == 1 && ref $_[0]){ # @_ : { name => $name, where => ... } + if(@_ == 1 && ref $_[0] ){ # @_ : { name => $name, where => ... } %args = %{$_[0]}; } - elsif(@_ == 2 && ref $_[1]){ # @_ : $name => { where => ... } + elsif(@_ == 2 && ref $_[1]) { # @_ : $name => { where => ... } $name = $_[0]; %args = %{$_[1]}; } - elsif(@_ % 2){ # @_ : $name => ( where => ... ) + elsif(@_ % 2) { # @_ : $name => ( where => ... ) ($name, %args) = @_; } - else{ # @_ : (name => $name, where => ...) + else{ # @_ : (name => $name, where => ...) %args = @_; } @@ -126,13 +124,15 @@ sub _create_type{ } $args{name} = $name; - my $parent; - if($mode eq 'subtype'){ - $parent = delete $args{as}; - if(!$parent){ - $parent = delete $args{name}; - $name = undef; - } + + my $parent = delete $args{as}; + if($is_subtype && !$parent){ + $parent = delete $args{name}; + $name = undef; + } + + if(defined $parent) { + $args{parent} = find_or_create_isa_type_constraint($parent); } if(defined $name){ @@ -145,27 +145,27 @@ sub _create_type{ } } - if($TYPE{$name}){ + if(defined $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" - ); + if($this ne $that) { + my $note = ''; + if($that eq __PACKAGE__) { + $note = sprintf " ('%s' is %s type constraint)", + $name, + scalar(grep { $name eq $_ } list_all_builtin_type_constraints()) + ? 'a builtin' + : 'an implicitly created'; + } + Carp::croak("The type constraint '$name' has already been created in $that" + . " and cannot be created again in $this" . $note); + } } } - else{ - $args{name} = '__ANON__'; - } $args{constraint} = delete $args{where} if exists $args{where}; $args{optimized} = delete $args{optimized_as} if exists $args{optimized_as}; - my $constraint; - if($mode eq 'subtype'){ - $constraint = find_or_create_isa_type_constraint($parent)->create_child_type(%args); - } - else{ - $constraint = Mouse::Meta::TypeConstraint->new(%args); - } + my $constraint = Mouse::Meta::TypeConstraint->new(%args); if(defined $name){ return $TYPE{$name} = $constraint; @@ -176,18 +176,17 @@ sub _create_type{ } sub type { - return _create_type('type', @_); + return _define_type 0, @_; } sub subtype { - return _create_type('subtype', @_); + return _define_type 1, @_; } -sub coerce { +sub coerce { # coerce $type, from $from, via { ... }, ... my $type_name = shift; - my $type = find_type_constraint($type_name) - or confess("Cannot find type '$type_name', perhaps you forgot to load it."); + or Carp::croak("Cannot find type '$type_name', perhaps you forgot to load it"); $type->_add_type_coercions(@_); return; @@ -198,9 +197,10 @@ sub class_type { my $class = $options->{class} || $name; # ClassType - return _create_type 'subtype', $name => ( + return subtype $name => ( as => 'Object', optimized_as => Mouse::Util::generate_isa_predicate_for($class), + class => $class, ); } @@ -209,24 +209,37 @@ sub role_type { my $role = $options->{role} || $name; # RoleType - return _create_type 'subtype', $name => ( + return subtype $name => ( as => 'Object', - optimized_as => sub { Scalar::Util::blessed($_[0]) && does_role($_[0], $role) }, + optimized_as => sub { + return Scalar::Util::blessed($_[0]) + && Mouse::Util::does_role($_[0], $role); + }, + role => $role, ); } sub duck_type { my($name, @methods); - if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){ + if(ref($_[0]) ne 'ARRAY'){ $name = shift; } @methods = (@_ == 1 && ref($_[0]) eq 'ARRAY') ? @{$_[0]} : @_; # DuckType - return _create_type 'type', $name => ( + return _define_type 1, $name => ( + as => 'Object', optimized_as => Mouse::Util::generate_can_predicate_for(\@methods), + message => sub { + my($object) = @_; + my @missing = grep { !$object->can($_) } @methods; + return ref($object) + . ' is missing methods ' + . Mouse::Util::quoted_english_list(@missing); + }, + methods => \@methods, ); } @@ -237,21 +250,28 @@ sub enum { $name = shift; } - %valid = map{ $_ => undef } (@_ == 1 && ref($_[0]) eq 'ARRAY' ? @{$_[0]} : @_); + %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]} }, + return _define_type 1, $name => ( + as => 'Str', + optimized_as => sub{ + return defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]}; + }, ); } sub _find_or_create_regular_type{ - my($spec) = @_; + my($spec, $create) = @_; return $TYPE{$spec} if exists $TYPE{$spec}; - my $meta = Mouse::Util::get_metaclass_by_name($spec) - or return undef; + my $meta = Mouse::Util::get_metaclass_by_name($spec); + + if(!defined $meta){ + return $create ? class_type($spec) : undef; + } if(Mouse::Util::is_a_metarole($meta)){ return role_type($spec); @@ -270,6 +290,7 @@ sub _find_or_create_parameterized_type{ } sub _find_or_create_union_type{ + return if grep{ not defined } @_; my @types = sort map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_; my $name = join '|', @types; @@ -282,104 +303,123 @@ sub _find_or_create_union_type{ } # The type parser -sub _parse_type{ - my($spec, $start) = @_; - - my @list; - my $subtype; - - my $len = length $spec; - my $i; - - for($i = $start; $i < $len; $i++){ - my $char = substr($spec, $i, 1); - if($char eq '['){ - my $base = _find_or_create_regular_type( substr($spec, $start, $i - $start) ) - or return; +# param : '[' type ']' | NOTHING +sub _parse_param { + my($c) = @_; - ($i, $subtype) = _parse_type($spec, $i+1) - or return; - $start = $i+1; # reset + if($c->{spec} =~ s/^\[//){ + my $type = _parse_type($c, 1); - push @list, _find_or_create_parameterized_type($base => $subtype); + if($c->{spec} =~ s/^\]//){ + return $type; } - elsif($char eq ']'){ - $len = $i+1; - last; - } - elsif($char eq '|'){ - my $type = _find_or_create_regular_type( substr($spec, $start, $i - $start) ); + Carp::croak("Syntax error in type: missing right square bracket in '$c->{orig}'"); + } - if(!defined $type){ - # XXX: Mouse creates a new class type, but Moose does not. - $type = class_type( substr($spec, $start, $i - $start) ); - } + return undef; +} - push @list, $type; +# name : [\w.:]+ +sub _parse_name { + my($c, $create) = @_; - ($i, $subtype) = _parse_type($spec, $i+1) - or return; + if($c->{spec} =~ s/\A ([\w.:]+) //xms){ + return _find_or_create_regular_type($1, $create); + } + Carp::croak("Syntax error in type: expect type name near '$c->{spec}' in '$c->{orig}'"); +} - $start = $i+1; # reset +# single_type : name param +sub _parse_single_type { + my($c, $create) = @_; - push @list, $subtype; - } - } - if($i - $start){ - my $type = _find_or_create_regular_type( substr $spec, $start, $i - $start ); + my $type = _parse_name($c, $create); + my $param = _parse_param($c); - if(defined $type){ - push @list, $type; + if(defined $type){ + if(defined $param){ + return _find_or_create_parameterized_type($type, $param); } - elsif($start != 0) { - # RT #50421 - # create a new class type - push @list, class_type( substr $spec, $start, $i - $start ); + else { + return $type; } } - - if(@list == 0){ - return; - } - elsif(@list == 1){ - return ($len, $list[0]); + elsif(defined $param){ + Carp::croak("Undefined type with parameter [$param] in '$c->{orig}'"); } else{ - return ($len, _find_or_create_union_type(@list)); + return undef; } } +# type : single_type ('|' single_type)* +sub _parse_type { + my($c, $create) = @_; + + my $type = _parse_single_type($c, $create); + if($c->{spec}){ # can be an union type + my @types; + while($c->{spec} =~ s/^\|//){ + push @types, _parse_single_type($c, $create); + } + if(@types){ + return _find_or_create_union_type($type, @types); + } + } + return $type; +} + sub find_type_constraint { my($spec) = @_; - return $spec if Mouse::Util::is_a_type_constraint($spec); - return undef if !defined $spec; + return $spec if Mouse::Util::is_a_type_constraint($spec) or not defined $spec; $spec =~ s/\s+//g; return $TYPE{$spec}; } +sub register_type_constraint { + my($constraint) = @_; + Carp::croak("No type supplied / type is not a valid type constraint") + unless Mouse::Util::is_a_type_constraint($constraint); + return $TYPE{$constraint->name} = $constraint; +} + sub find_or_parse_type_constraint { my($spec) = @_; - return $spec if Mouse::Util::is_a_type_constraint($spec); - return undef if !defined $spec; + return $spec if Mouse::Util::is_a_type_constraint($spec) or not defined $spec; - $spec =~ s/\s+//g; - return $TYPE{$spec} || do{ - my($pos, $type) = _parse_type($spec, 0); - $type; - }; + $spec =~ tr/ \t\r\n//d; + + my $tc = $TYPE{$spec}; + if(defined $tc) { + return $tc; + } + + my %context = ( + spec => $spec, + orig => $spec, + ); + $tc = _parse_type(\%context); + + if($context{spec}){ + Carp::croak("Syntax error: extra elements '$context{spec}' in '$context{orig}'"); + } + + return $TYPE{$spec} = $tc; } sub find_or_create_does_type_constraint{ # XXX: Moose does not register a new role_type, but Mouse does. - return find_or_parse_type_constraint(@_) || role_type(@_); + my $tc = find_or_parse_type_constraint(@_); + return defined($tc) ? $tc : role_type(@_); } sub find_or_create_isa_type_constraint { # XXX: Moose does not register a new class_type, but Mouse does. - return find_or_parse_type_constraint(@_) || class_type(@_); + my $tc = find_or_parse_type_constraint(@_); + return defined($tc) ? $tc : class_type(@_); } 1; @@ -391,7 +431,7 @@ Mouse::Util::TypeConstraints - Type constraint system for Mouse =head1 VERSION -This document describes Mouse version 0.50_04 +This document describes Mouse version 0.82 =head2 SYNOPSIS @@ -492,10 +532,6 @@ If Mouse 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 treated as a new type -name, I as a parameterization of C. - B The C type constraint for the most part works correctly now, but edge cases may still exist, please use it sparingly.