package Mouse::Util::TypeConstraints;
use strict;
use warnings;
-use base 'Exporter';
-use Carp ();
+use Exporter;
+
+use Carp qw(confess);
use Scalar::Util qw/blessed looks_like_number openhandle/;
+
+use Mouse::Util qw(does_role not_supported);
+use Mouse::Meta::Module; # class_of
use Mouse::Meta::TypeConstraint;
+use constant _DEBUG => !!$ENV{TC_DEBUG};
+
+our @ISA = qw(Exporter);
our @EXPORT = qw(
as where message from via type subtype coerce class_type role_type enum
find_type_constraint
);
my %TYPE;
-my %TYPE_SOURCE;
my %COERCE;
my %COERCE_KEYS;
return(message => $_[0])
}
-sub from { @_ }
+sub from { @_ }
sub via (&) { $_[0] }
BEGIN {
- no warnings 'uninitialized';
- %TYPE = (
- Any => sub { 1 },
- Item => sub { 1 },
- Bool => sub {
- !defined($_[0]) || $_[0] eq "" || "$_[0]" eq '1' || "$_[0]" eq '0'
- },
+ my %builtins = (
+ Any => undef, # null check
+ Item => undef, # null check
+ Maybe => undef, # null check
+
+ Bool => sub { $_[0] ? $_[0] eq '1' : 1 },
Undef => sub { !defined($_[0]) },
Defined => sub { defined($_[0]) },
Value => sub { defined($_[0]) && !ref($_[0]) },
Num => sub { !ref($_[0]) && looks_like_number($_[0]) },
Int => sub { defined($_[0]) && !ref($_[0]) && $_[0] =~ /^-?[0-9]+$/ },
Str => sub { defined($_[0]) && !ref($_[0]) },
- ClassName => sub { Mouse::is_class_loaded($_[0]) },
Ref => sub { ref($_[0]) },
ScalarRef => sub { ref($_[0]) eq 'SCALAR' },
},
Object => sub { blessed($_[0]) && blessed($_[0]) ne 'Regexp' },
+
+ ClassName => sub { Mouse::Util::is_class_loaded($_[0]) },
+ RoleName => sub { (Mouse::Util::find_meta($_[0]) || return 0)->isa('Mouse::Meta::Role') },
);
- while (my ($name, $code) = each %TYPE) {
- $TYPE{$name} = Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $name );
+
+ while (my ($name, $code) = each %builtins) {
+ $TYPE{$name} = Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ optimized => $code,
+ );
+ }
+
+ sub optimized_constraints {
+ Carp::cluck('optimized_constraints() has been deprecated');
+ return \%TYPE;
}
- sub optimized_constraints { \%TYPE }
- my @TYPE_KEYS = keys %TYPE;
- sub list_all_builtin_type_constraints { @TYPE_KEYS }
+ my @builtins = keys %TYPE;
+ sub list_all_builtin_type_constraints { @builtins }
- @TYPE_SOURCE{@TYPE_KEYS} = (__PACKAGE__) x @TYPE_KEYS;
+ sub list_all_type_constraints { keys %TYPE }
}
-sub type {
- my $pkg = caller(0);
- my($name, %conf) = @_;
+sub _create_type{
+ my $mode = shift;
+
+ my $name;
+ my %args;
- if ($TYPE{$name} && $TYPE_SOURCE{$name} ne $pkg) {
- Carp::croak "The type constraint '$name' has already been created in $TYPE_SOURCE{$name} and cannot be created again in $pkg";
+ if(@_ == 1 && ref $_[0]){ # @_ : { name => $name, where => ... }
+ %args = %{$_[0]};
+ }
+ elsif(@_ == 2 && ref $_[1]){ # @_ : $name => { where => ... }
+ $name = $_[0];
+ %args = %{$_[1]};
+ }
+ elsif(@_ % 2){ # @_ : $name => ( where => ... )
+ ($name, %args) = @_;
+ }
+ else{ # @_ : (name => $name, where => ...)
+ %args = @_;
}
- my $constraint = $conf{where} || do {
- my $as = delete $conf{as} || 'Any';
- if (! exists $TYPE{$as}) {
- $TYPE{$as} = _build_type_constraint($as);
- }
- $TYPE{$as};
- };
- $TYPE_SOURCE{$name} = $pkg;
- $TYPE{$name} = Mouse::Meta::TypeConstraint->new(
- name => $name,
- _compiled_type_constraint => sub {
- local $_ = $_[0];
- if (ref $constraint eq 'CODE') {
- $constraint->($_[0])
- } else {
- $constraint->check($_[0])
- }
+ if(!defined $name){
+ if(!defined($name = $args{name})){
+ $name = '__ANON__';
}
- );
+ }
+
+ $args{name} = $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");
+ }
+
+ $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'){
+ my $parent = exists($args{as}) ? delete($args{as}) : delete($args{name});
+
+ $parent = find_or_create_isa_type_constraint($parent);
+ $constraint = $parent->create_child_type(%args);
+ }
+ else{
+ $constraint = Mouse::Meta::TypeConstraint->new(%args);
+ }
+
+ return $TYPE{$name} = $constraint;
}
-sub subtype {
- my $pkg = caller(0);
- my($name, %conf) = @_;
- if ($TYPE{$name} && $TYPE_SOURCE{$name} ne $pkg) {
- Carp::croak "The type constraint '$name' has already been created in $TYPE_SOURCE{$name} and cannot be created again in $pkg";
- };
- my $constraint = delete $conf{where};
- my $as_constraint = find_or_create_isa_type_constraint(delete $conf{as} || 'Any');
-
- $TYPE_SOURCE{$name} = $pkg;
- $TYPE{$name} = Mouse::Meta::TypeConstraint->new(
- name => $name,
- _compiled_type_constraint => (
- $constraint ?
- sub {
- local $_ = $_[0];
- $as_constraint->check($_[0]) && $constraint->($_[0])
- } :
- sub {
- local $_ = $_[0];
- $as_constraint->check($_[0]);
- }
- ),
- %conf
- );
+sub type {
+ return _create_type('type', @_);
+}
- return $name;
+sub subtype {
+ return _create_type('subtype', @_);
}
sub coerce {
my $name = shift;
- Carp::croak "Cannot find type '$name', perhaps you forgot to load it."
+ $name =~ s/\s+//g;
+ confess "Cannot find type '$name', perhaps you forgot to load it."
unless $TYPE{$name};
unless ($COERCE{$name}) {
$COERCE_KEYS{$name} = [];
}
- while (my($type, $code) = splice @_, 0, 2) {
- Carp::croak "A coercion action already exists for '$type'"
- if $COERCE{$name}->{$type};
+ my $package_defined_in = caller;
- if (! $TYPE{$type}) {
- # looks parameterized
- if ($type =~ /^[^\[]+\[.+\]$/) {
- $TYPE{$type} = _build_type_constraint($type);
- } else {
- Carp::croak "Could not find the type constraint ($type) to coerce from"
- }
+ while (my($from, $action) = splice @_, 0, 2) {
+ $from =~ s/\s+//g;
+
+ confess "A coercion action already exists for '$from'"
+ if $COERCE{$name}->{$from};
+
+ my $type = find_or_parse_type_constraint($from, $package_defined_in);
+ if (!$type) {
+ confess "Could not find the type constraint ($from) to coerce from"
}
+ warn "# REGISTER COERCE $name, from $type\n" if _DEBUG;
+
push @{ $COERCE_KEYS{$name} }, $type;
- $COERCE{$name}->{$type} = $code;
+ $COERCE{$name}->{$from} = $action;
}
return;
}
if ($conf && $conf->{class}) {
# No, you're using this wrong
warn "class_type() should be class_type(ClassName). Perhaps you're looking for subtype $name => as '$conf->{class}'?";
- subtype($name, as => $conf->{class});
- } else {
- subtype(
- $name => where => sub { $_->isa($name) }
+ _create_type 'type', $name => (
+ as => $conf->{class},
+
+ type => 'Class',
+ );
+ }
+ else {
+ _create_type 'type', $name => (
+ optimized_as => sub { blessed($_[0]) && $_[0]->isa($name) },
+
+ type => 'Class',
);
}
}
sub role_type {
my($name, $conf) = @_;
- my $role = $conf->{role};
- subtype(
- $name => where => sub {
- return unless defined $_ && ref($_) && $_->isa('Mouse::Object');
- $_->meta->does_role($role);
- }
+ my $role = ($conf && $conf->{role}) ? $conf->{role} : $name;
+ _create_type 'type', $name => (
+ optimized_as => sub { blessed($_[0]) && does_role($_[0], $role) },
+
+ type => 'Role',
);
}
# this is an original method for Mouse
sub typecast_constraints {
my($class, $pkg, $types, $value) = @_;
- Carp::croak("wrong arguments count") unless @_==4;
+ Carp::croak("wrong arguments count") unless @_ == 4;
local $_;
- for my $type ( split /\|/, $types ) {
- next unless $COERCE{$type};
+ for my $type ($types->{type_constraints} ? @{$types->{type_constraints}} : $types ) {
for my $coerce_type (@{ $COERCE_KEYS{$type}}) {
+
+ if(_DEBUG){
+ warn sprintf "# COERCE: from %s to %s for %s (%s)\n",
+ $coerce_type, $type, defined($value) ? "'$value'" : 'undef',
+ $coerce_type->check($value) ? "try" : "skip";
+ }
+
+ next if !$coerce_type->check($value);
+
+ # try to coerce
$_ = $value;
- next unless $TYPE{$coerce_type}->check($value);
- $_ = $value;
- $_ = $COERCE{$type}->{$coerce_type}->($value);
- return $_ if $types->check($_);
+ my $coerced = $COERCE{$type}->{$coerce_type}->($value); # coerce
+
+ if(_DEBUG){
+ warn sprintf "# COERCE: got %s, which is%s %s\n",
+ defined($coerced) ? $coerced : 'undef', $types->check($coerced) ? '' : ' not', $types;
+ }
+
+ # check with $types, not $constraint
+ return $coerced if $types->check($coerced);
}
}
- return $value;
+ return $value; # returns original $value
}
-my $serial_enum = 0;
sub enum {
+ my($name, %valid);
+
# enum ['small', 'medium', 'large']
if (ref($_[0]) eq 'ARRAY') {
- my @elements = @{ shift @_ };
+ %valid = map{ $_ => undef } @{ $_[0] };
+ $name = sprintf '(%s)', join '|', sort @{$_[0]};
+ }
+ # enum size => 'small', 'medium', 'large'
+ else{
+ $name = shift;
+ %valid = map{ $_ => undef } @_;
+ }
+ return _create_type 'type', $name => (
+ optimized_as => sub{ defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]} },
+
+ type => 'Enum',
+ );
+}
- my $name = 'Mouse::Util::TypeConstaints::Enum::Serial::'
- . ++$serial_enum;
- enum($name, @elements);
- return $name;
+sub _find_or_create_regular_type{
+ my($spec) = @_;
+
+ return $TYPE{$spec} if exists $TYPE{$spec};
+
+ my $meta = Mouse::Meta::Module::class_of($spec);
+
+ if(!$meta){
+ return;
}
- # enum size => 'small', 'medium', 'large'
- my $name = shift;
- my %is_valid = map { $_ => 1 } @_;
+ my $check;
+ my $type;
+ if($meta->isa('Mouse::Meta::Role')){
+ $check = sub{
+ return blessed($_[0]) && $_[0]->does($spec);
+ };
+ $type = 'Role';
+ }
+ else{
+ $check = sub{
+ return blessed($_[0]) && $_[0]->isa($spec);
+ };
+ $type = 'Class';
+ }
+
+ warn "#CREATE a $type type for $spec\n" if _DEBUG;
+
+ return $TYPE{$spec} = Mouse::Meta::TypeConstraint->new(
+ name => $spec,
+ optimized => $check,
- subtype(
- $name => where => sub { $is_valid{$_} }
+ type => $type,
);
}
-sub _build_type_constraint {
+$TYPE{ArrayRef}{constraint_generator} = sub {
+ my($type_parameter) = @_;
+ my $check = $type_parameter->_compiled_type_constraint;
- my $spec = shift;
- my $code;
- $spec =~ s/\s+//g;
- if ($spec =~ /^([^\[]+)\[(.+)\]$/) {
- # parameterized
- my $constraint = $1;
- my $param = $2;
- my $parent;
- if ($constraint eq 'Maybe') {
- $parent = _build_type_constraint('Undef');
- } else {
- $parent = _build_type_constraint($constraint);
+ return sub{
+ foreach my $value (@{$_}) {
+ return undef unless $check->($value);
}
- my $child = _build_type_constraint($param);
- if ($constraint eq 'ArrayRef') {
- my $code_str =
- "#line " . __LINE__ . ' "' . __FILE__ . "\"\n" .
- "sub {\n" .
- " if (\$parent->check(\$_[0])) {\n" .
- " foreach my \$e (\@{\$_[0]}) {\n" .
- " return () unless \$child->check(\$e);\n" .
- " }\n" .
- " return 1;\n" .
- " }\n" .
- " return ();\n" .
- "};\n"
- ;
- $code = eval $code_str or Carp::confess("Failed to generate inline type constraint: $@");
- } elsif ($constraint eq 'HashRef') {
- my $code_str =
- "#line " . __LINE__ . ' "' . __FILE__ . "\"\n" .
- "sub {\n" .
- " if (\$parent->check(\$_[0])) {\n" .
- " foreach my \$e (values \%{\$_[0]}) {\n" .
- " return () unless \$child->check(\$e);\n" .
- " }\n" .
- " return 1;\n" .
- " }\n" .
- " return ();\n" .
- "};\n"
- ;
- $code = eval $code_str or Carp::confess($@);
- } elsif ($constraint eq 'Maybe') {
- my $code_str =
- "#line " . __LINE__ . ' "' . __FILE__ . "\"\n" .
- "sub {\n" .
- " return \$child->check(\$_[0]) || \$parent->check(\$_[0]);\n" .
- "};\n"
- ;
- $code = eval $code_str or Carp::confess($@);
- } else {
- Carp::confess("Support for parameterized types other than Maybe, ArrayRef or HashRef is not implemented yet");
+ 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);
}
- $TYPE{$spec} = Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $spec );
- } else {
- $code = $TYPE{ $spec };
- if (! $code) {
- # is $spec a known role? If so, constrain with 'does' instead of 'isa'
- require Mouse::Meta::Role;
- my $check = Mouse::Meta::Role->_metaclass_cache($spec)?
- 'does' : 'isa';
- my $code_str =
- "#line " . __LINE__ . ' "' . __FILE__ . "\"\n" .
- "sub {\n" .
- " Scalar::Util::blessed(\$_[0]) && \$_[0]->$check('$spec');\n" .
- "}"
- ;
- $code = eval $code_str or Carp::confess($@);
- $TYPE{$spec} = Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $spec );
+ 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{
+ warn "#CREATE a Parameterized type for $name\n" if _DEBUG;
+
+ 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',
+ );
}
- return Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $spec );
}
+sub _find_or_create_union_type{
+ my @types = map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
-sub find_type_constraint {
- my $type_constraint = shift;
- return $TYPE{$type_constraint};
+ my $name = join '|', map{ $_->name } @types;
+
+ $TYPE{$name} ||= do{
+ warn "# CREATE a Union type for ", Mouse::Util::english_list(@types),"\n" if _DEBUG;
+
+ return Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ type_constraints => \@types,
+
+ type => 'Union',
+ );
+ };
}
-sub find_or_create_isa_type_constraint {
- my $type_constraint = shift;
-
- Carp::confess("Got isa => type_constraints, but Mouse does not yet support parameterized types for containers other than ArrayRef and HashRef and Maybe (rt.cpan.org #39795)")
- if $type_constraint =~ /\A ( [^\[]+ ) \[\.+\] \z/xms &&
- $1 ne 'ArrayRef' &&
- $1 ne 'HashRef' &&
- $1 ne 'Maybe'
- ;
-
- my $code;
-
- $type_constraint =~ s/\s+//g;
-
- $code = $TYPE{$type_constraint};
- if (! $code) {
- my @type_constraints = split /\|/, $type_constraint;
- if (@type_constraints == 1) {
- $code = $TYPE{$type_constraints[0]} ||
- _build_type_constraint($type_constraints[0]);
- } else {
- my @code_list = map {
- $TYPE{$_} || _build_type_constraint($_)
- } @type_constraints;
- $code = Mouse::Meta::TypeConstraint->new(
- _compiled_type_constraint => sub {
- my $i = 0;
- for my $code (@code_list) {
- return 1 if $code->check($_[0]);
- }
- return 0;
- },
- name => $type_constraint,
- );
+# 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;
+
+ ($i, $subtype) = _parse_type($spec, $i+1)
+ or return;
+ $start = $i+1; # reset
+
+ push @list, _find_or_create_parameterized_type($base => $subtype);
+ }
+ elsif($char eq ']'){
+ $len = $i+1;
+ last;
+ }
+ elsif($char eq '|'){
+ my $type = _find_or_create_regular_type( substr($spec, $start, $i - $start) );
+
+ if(!defined $type){
+ # XXX: Mouse creates a new class type, but Moose does not.
+ $type = class_type( substr($spec, $start, $i - $start) );
+ }
+
+ push @list, $type;
+
+ ($i, $subtype) = _parse_type($spec, $i+1)
+ or return;
+
+ $start = $i+1; # reset
+
+ push @list, $subtype;
}
}
- return $code;
+ if($i - $start){
+ push @list, _find_or_create_regular_type(substr $spec, $start, $i - $start);
+ }
+
+ if(@list == 0){
+ return;
+ }
+ elsif(@list == 1){
+ return ($len, $list[0]);
+ }
+ else{
+ return ($len, _find_or_create_union_type(@list));
+ }
+}
+
+
+sub find_type_constraint {
+ my($spec) = @_;
+ return $spec if blessed($spec) && $spec->isa('Mouse::Meta::TypeConstraint');
+
+ $spec =~ s/\s+//g;
+ return $TYPE{$spec};
+}
+
+sub find_or_parse_type_constraint {
+ my($spec) = @_;
+ return $spec if blessed($spec) && $spec->isa('Mouse::Meta::TypeConstraint');
+
+ $spec =~ s/\s+//g;
+ return $TYPE{$spec} || do{
+ my($pos, $type) = _parse_type($spec, 0);
+ $type;
+ };
+}
+
+sub find_or_create_does_type_constraint{
+ my $type = find_or_parse_type_constriant(@_) || role_type(@_);
+
+ if($type->{type} && $type->{type} ne 'Role'){
+ Carp::cluck("$type is not a role type");
+ }
+ return $type;
+}
+
+sub find_or_create_isa_type_constraint {
+ return find_or_parse_type_constraint(@_) || class_type(@_);
}
1;
GlobRef
FileHandle
Object
- Role
B<NOTE:> Any type followed by a type parameter C<[`a]> can be
parameterized, this means you can say:
=over 4
-=item B<subtype 'Name' => as 'Parent' => where { } ...>
+=item C<< subtype 'Name' => 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 B<subtype as 'Parent' => where { } ...>
+=item C<< enum (\@values) -> Mouse::Meta::TypeConstraint >>
-=item B<class_type ($class, ?$options)>
+=back
-=item B<role_type ($role, ?$options)>
+=over 4
-=item B<enum (\@values)>
+=item C<< find_type_constraint(Type) -> Mouse::Meta::TypeConstraint >>
=back
=head1 THANKS
-Much of this documentation was taken from L<Moose::Util::TypeConstraints>
+Much of this documentation was taken from C<Moose::Util::TypeConstraints>
+
+=head1 SEE ALSO
+
+L<Moose::Util::TypeConstraints>
=cut