package Mouse::Util::TypeConstraints;
use Mouse::Util qw(does_role not_supported); # enables strict and warnings
-use Carp qw(confess);
+use Carp ();
use Scalar::Util ();
use Mouse::Meta::TypeConstraint;
)],
);
+our @CARP_NOT = qw(Mouse::Meta::Attribute);
+
my %TYPE;
-sub as ($) { (as => $_[0]) }
-sub where (&) { (where => $_[0]) }
-sub message (&) { (message => $_[0]) }
-sub optimize_as (&) { (optimize_as => $_[0]) }
+# The root type
+$TYPE{Any} = Mouse::Meta::TypeConstraint->new(
+ name => 'Any',
+);
-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,
+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,
);
+}
- while (my ($name, $code) = each %builtins) {
- $TYPE{$name} = Mouse::Meta::TypeConstraint->new(
- name => $name,
- optimized => $code,
- );
- }
+# make it parametarizable
- sub optimized_constraints { # DEPRECATED
- Carp::cluck('optimized_constraints() has been deprecated');
- return \%TYPE;
- }
+$TYPE{Maybe} {constraint_generator} = \&_parameterize_Maybe_for;
+$TYPE{ArrayRef}{constraint_generator} = \&_parameterize_ArrayRef_for;
+$TYPE{HashRef} {constraint_generator} = \&_parameterize_HashRef_for;
- my @builtins = keys %TYPE;
- sub list_all_builtin_type_constraints { @builtins }
+# sugars
- sub list_all_type_constraints { keys %TYPE }
+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] } ## no critic
+
+# type utilities
+
+sub optimized_constraints { # DEPRECATED
+ Carp::cluck('optimized_constraints() has been deprecated');
+ return \%TYPE;
}
+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;
}
if(defined $name){
- my $package_defined_in = $args{package_defined_in} ||= caller(1);
- 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");
+ # 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;
+ }
+ }
+
+ if($TYPE{$name}){
+ my $that = $TYPE{$name}->{package_defined_in} || __PACKAGE__;
+ ($this eq $that) or Carp::croak(
+ "The type constraint '$name' has already been created in $that and cannot be created again in $this"
+ );
}
}
else{
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;
sub class_type {
my($name, $options) = @_;
my $class = $options->{class} || $name;
+
+ # ClassType
return _create_type 'subtype', $name => (
as => 'Object',
optimized_as => Mouse::Util::generate_isa_predicate_for($class),
-
- type => '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',
);
}
@methods = (@_ == 1 && ref($_[0]) eq 'ARRAY') ? @{$_[0]} : @_;
- return _create_type 'type', $name => (
+ # DuckType
+ return _create_type 'subtype', $name => (
+ as => 'Object',
optimized_as => Mouse::Util::generate_can_predicate_for(\@methods),
-
- type => 'DuckType',
);
}
-sub typecast_constraints { # DEPRECATED
- my($class, $pkg, $type, $value) = @_;
- Carp::croak("wrong arguments count") unless @_ == 4;
-
- Carp::cluck("typecast_constraints() has been deprecated, which was an internal utility anyway");
-
- return $type->coerce($value);
-}
-
sub enum {
my($name, %valid);
%valid = map{ $_ => undef } (@_ == 1 && ref($_[0]) eq 'ARRAY' ? @{$_[0]} : @_);
- return _create_type 'type', $name => (
+ # EnumType
+ return _create_type 'subtype', $name => (
+ as => 'Str',
optimized_as => sub{ defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]} },
-
- type => 'Enum',
);
}
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);
}
}
-$TYPE{ArrayRef}{constraint_generator} = \&_parameterize_ArrayRef_for;
-$TYPE{HashRef}{constraint_generator} = \&_parameterize_HashRef_for;
-$TYPE{Maybe}{constraint_generator} = \&_parameterize_Maybe_for;
-
sub _find_or_create_parameterized_type{
my($base, $param) = @_;
}
sub _find_or_create_union_type{
+ return if grep{ not defined } @_;
my @types = sort map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
my $name = join '|', @types;
+ # UnionType
$TYPE{$name} ||= Mouse::Meta::TypeConstraint->new(
name => $name,
type_constraints => \@types,
-
- type => 'Union',
);
}
# The type parser
-sub _parse_type{
- my($spec, $start) = @_;
-
- my @list;
- my $subtype;
- my $len = length $spec;
- my $i;
+# param : '[' type ']' | NOTHING
+sub _parse_param {
+ my($c) = @_;
- for($i = $start; $i < $len; $i++){
- my $char = substr($spec, $i, 1);
+ if($c->{spec} =~ s/^\[//){
+ my $type = _parse_type($c, 1);
- if($char eq '['){
- my $base = _find_or_create_regular_type( substr($spec, $start, $i - $start) )
- or return;
-
- ($i, $subtype) = _parse_type($spec, $i+1)
- or return;
- $start = $i+1; # reset
-
- 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;
$spec =~ s/\s+//g;
return $TYPE{$spec};
sub find_or_parse_type_constraint {
my($spec) = @_;
return $spec if Mouse::Util::is_a_type_constraint($spec);
+ return undef if !defined $spec;
$spec =~ s/\s+//g;
return $TYPE{$spec} || do{
- my($pos, $type) = _parse_type($spec, 0);
+ my $context = {
+ spec => $spec,
+ orig => $spec,
+ };
+ my $type = _parse_type($context);
+
+ if($context->{spec}){
+ Carp::croak("Syntax error: extra elements '$context->{spec}' in '$context->{orig}'");
+ }
$type;
};
}
=head1 VERSION
-This document describes Mouse version 0.45
+This document describes Mouse version 0.57
=head2 SYNOPSIS
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.