package Mouse::Util::TypeConstraints;
-use strict;
-use warnings;
-use base 'Exporter';
+use Mouse::Util qw(does_role not_supported); # enables strict and warnings
-use Carp ();
-use Scalar::Util qw/blessed looks_like_number openhandle/;
+use Carp qw(confess);
+use Scalar::Util ();
-use Mouse::Util;
use Mouse::Meta::TypeConstraint;
-
-our @EXPORT = qw(
- as where message from via type subtype coerce class_type role_type enum
- find_type_constraint
+use Mouse::Exporter;
+
+Mouse::Exporter->setup_import_methods(
+ as_is => [qw(
+ as where message optimize_as
+ from via
+ type subtype coerce class_type role_type enum
+ find_type_constraint
+ )],
);
my %TYPE;
-my %TYPE_SOURCE;
-my %COERCE;
-my %COERCE_KEYS;
-sub as ($) {
- return(as => $_[0]);
-}
-sub where (&) {
- return(where => $_[0])
-}
-sub message (&) {
- return(message => $_[0])
-}
+sub as ($) { (as => $_[0]) }
+sub where (&) { (where => $_[0]) }
+sub message (&) { (message => $_[0]) }
+sub optimize_as (&) { (optimize_as => $_[0]) }
sub from { @_ }
sub via (&) { $_[0] }
-sub export_type_constraints_as_functions {
- my $into = caller;
-
- foreach my $constraint ( values %TYPE ) {
- my $tc = $constraint->{_compiled_type_constraint};
- my $as = $into . '::' . $constraint->{name};
-
- no strict 'refs';
- *{$as} = sub{ &{$tc} || undef };
- }
- return;
-}
-
BEGIN {
- %TYPE = (
- Any => sub { 1 },
- Item => sub { 1 },
-
- 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]) },
- Ref => sub { ref($_[0]) },
-
- ScalarRef => sub { ref($_[0]) eq 'SCALAR' },
- ArrayRef => sub { ref($_[0]) eq 'ARRAY' },
- HashRef => sub { ref($_[0]) eq 'HASH' },
- CodeRef => sub { ref($_[0]) eq 'CODE' },
- RegexpRef => sub { ref($_[0]) eq 'Regexp' },
- GlobRef => sub { ref($_[0]) eq 'GLOB' },
-
- FileHandle => sub {
- ref($_[0]) eq 'GLOB' && openhandle($_[0])
- or
- blessed($_[0]) && $_[0]->isa("IO::Handle")
- },
-
- 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') },
+ 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 %TYPE) {
+
+ while (my ($name, $code) = each %builtins) {
$TYPE{$name} = Mouse::Meta::TypeConstraint->new(
- name => $name,
- _compiled_type_constraint => $code,
+ name => $name,
+ optimized => $code,
);
- $TYPE_SOURCE{$name} = __PACKAGE__;
}
- sub optimized_constraints { \%TYPE }
+ sub optimized_constraints { # DEPRECATED
+ Carp::cluck('optimized_constraints() has been deprecated');
+ return \%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 }
+
+ sub list_all_type_constraints { keys %TYPE }
}
-sub 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');
+}
+
+
+sub _create_type{
+ my $mode = shift;
+
my $name;
- my %conf;
+ my %args;
- if(@_ == 1 && ref $_[0]){ # type { where => ... }
- %conf = %{$_[0]};
+ if(@_ == 1 && ref $_[0]){ # @_ : { name => $name, where => ... }
+ %args = %{$_[0]};
}
- elsif(@_ == 2 && ref $_[1]){ # type $name => { where => ... }*
+ elsif(@_ == 2 && ref $_[1]){ # @_ : $name => { where => ... }
$name = $_[0];
- %conf = %{$_[1]};
+ %args = %{$_[1]};
}
- elsif(@_ % 2){ # odd number of arguments
- $name = shift;
- %conf = @_;
+ elsif(@_ % 2){ # @_ : $name => ( where => ... )
+ ($name, %args) = @_;
}
- else{
- %conf = @_;
+ else{ # @_ : (name => $name, where => ...)
+ %args = @_;
}
- $name = '__ANON__' if !defined $name;
+ if(!defined $name){
+ if(!defined($name = $args{name})){
+ $name = '__ANON__';
+ }
+ }
- my $pkg = caller;
+ $args{name} = $name;
+ my $parent;
+ if($mode eq 'subtype'){
+ $parent = delete $args{as};
+ if(!$parent){
+ $parent = delete $args{name};
+ $name = '__ANON__';
+ }
+ }
- 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 $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");
}
- my $constraint = $conf{where} || do {
- my $as = delete $conf{as} || 'Any';
- ($TYPE{$as} ||= _build_type_constraint($as))->{_compiled_type_constraint};
- };
+ $args{constraint} = delete $args{where} if exists $args{where};
+ $args{optimized} = delete $args{optimized_as} if exists $args{optimized_as};
- my $tc = Mouse::Meta::TypeConstraint->new(
- name => $name,
- _compiled_type_constraint => sub {
- local $_ = $_[0];
- return &{$constraint};
- },
- );
+ 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);
+ }
- $TYPE_SOURCE{$name} = $pkg;
- $TYPE{$name} = $tc;
+ return $TYPE{$name} = $constraint;
+}
- return $tc;
+sub type {
+ return _create_type('type', @_);
}
sub subtype {
- my $name;
- my %conf;
+ return _create_type('subtype', @_);
+}
- if(@_ == 1 && ref $_[0]){ # type { where => ... }
- %conf = %{$_[0]};
- }
- elsif(@_ == 2 && ref $_[1]){ # type $name => { where => ... }*
- $name = $_[0];
- %conf = %{$_[1]};
- }
- elsif(@_ % 2){ # odd number of arguments
- $name = shift;
- %conf = @_;
+sub coerce {
+ my $type_name = shift;
+
+ my $type = find_type_constraint($type_name)
+ or confess("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;
+ return _create_type 'subtype', $name => (
+ as => 'Object',
+ optimized_as => _generate_class_type_for($class),
+
+ type => 'Class',
+ );
+}
+
+sub role_type {
+ my($name, $options) = @_;
+ my $role = $options->{role} || $name;
+ 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;
+
+ Carp::cluck("typecast_constraints() has been deprecated, which was an internal utility anyway");
+
+ return $type->coerce($value);
+}
+
+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{
- %conf = @_;
+ $name = shift;
+ %valid = map{ $_ => undef } @_;
}
+ return _create_type 'type', $name => (
+ optimized_as => sub{ defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]} },
- $name = '__ANON__' if !defined $name;
+ type => 'Enum',
+ );
+}
+
+sub _find_or_create_regular_type{
+ my($spec) = @_;
+
+ return $TYPE{$spec} if exists $TYPE{$spec};
- my $pkg = caller;
+ my $meta = Mouse::Util::get_metaclass_by_name($spec)
+ or return undef;
- 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(_is_a_metarole($meta)){
+ return role_type($spec);
}
+ else{
+ return class_type($spec);
+ }
+}
- my $constraint = delete $conf{where};
- my $as_constraint = find_or_create_isa_type_constraint(delete $conf{as} || 'Any')
- ->{_compiled_type_constraint};
-
- my $tc = Mouse::Meta::TypeConstraint->new(
- name => $name,
- _compiled_type_constraint => (
- $constraint ?
- sub {
- local $_ = $_[0];
- $as_constraint->($_[0]) && $constraint->($_[0])
- } :
- sub {
- local $_ = $_[0];
- $as_constraint->($_[0]);
- }
- ),
- %conf,
- );
+$TYPE{ArrayRef}{constraint_generator} = sub {
+ my($type_parameter) = @_;
+ my $check = $type_parameter->_compiled_type_constraint;
- $TYPE_SOURCE{$name} = $pkg;
- $TYPE{$name} = $tc;
+ 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;
+ };
+};
- return $tc;
-}
+# 'Maybe' type accepts 'Any', so it requires parameters
+$TYPE{Maybe}{constraint_generator} = sub {
+ my($type_parameter) = @_;
+ my $check = $type_parameter->_compiled_type_constraint;
-sub coerce {
- my $name = shift;
+ return sub{
+ return !defined($_) || $check->($_);
+ };
+};
- Carp::croak "Cannot find type '$name', perhaps you forgot to load it."
- unless $TYPE{$name};
+sub _find_or_create_parameterized_type{
+ my($base, $param) = @_;
- unless ($COERCE{$name}) {
- $COERCE{$name} = {};
- $COERCE_KEYS{$name} = [];
- }
+ my $name = sprintf '%s[%s]', $base->name, $param->name;
- while (my($type, $code) = splice @_, 0, 2) {
- Carp::croak "A coercion action already exists for '$type'"
- if $COERCE{$name}->{$type};
+ $TYPE{$name} ||= do{
+ my $generator = $base->{constraint_generator};
- 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"
- }
+ if(!$generator){
+ confess("The $name constraint cannot be used, because $param doesn't subtype from a parameterizable type");
}
- push @{ $COERCE_KEYS{$name} }, $type;
- $COERCE{$name}->{$type} = $code;
+ Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ parent => $base,
+ constraint => $generator->($param),
+
+ type => 'Parameterized',
+ );
}
- return;
}
+sub _find_or_create_union_type{
+ my @types = sort{ $a cmp $b } map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
-sub class_type {
- my($name, $conf) = @_;
- 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) }
+ my $name = join '|', @types;
+
+ $TYPE{$name} ||= do{
+ return Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ type_constraints => \@types,
+
+ type => 'Union',
);
- }
+ };
}
-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);
+# 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) );
+ }
-# this is an original method for Mouse
-sub typecast_constraints {
- my($class, $pkg, $types, $value) = @_;
- Carp::croak("wrong arguments count") unless @_==4;
-
- local $_;
- for my $type ( split /\|/, $types ) {
- next unless $COERCE{$type};
- for my $coerce_type (@{ $COERCE_KEYS{$type}}) {
- $_ = $value;
- next unless $TYPE{$coerce_type}->check($value);
- $_ = $value;
- $_ = $COERCE{$type}->{$coerce_type}->($value);
- return $_ if $types->check($_);
+ push @list, $type;
+
+ ($i, $subtype) = _parse_type($spec, $i+1)
+ or return;
+
+ $start = $i+1; # reset
+
+ push @list, $subtype;
}
}
- return $value;
-}
+ if($i - $start){
+ my $type = _find_or_create_regular_type( substr $spec, $start, $i - $start );
-my $serial_enum = 0;
-sub enum {
- # enum ['small', 'medium', 'large']
- if (ref($_[0]) eq 'ARRAY') {
- my @elements = @{ shift @_ };
+ if(defined $type){
+ push @list, $type;
+ }
+ elsif($start != 0) {
+ # RT #50421
+ # create a new class type
+ push @list, class_type( substr $spec, $start, $i - $start );
+ }
+ }
- my $name = 'Mouse::Util::TypeConstaints::Enum::Serial::'
- . ++$serial_enum;
- enum($name, @elements);
- return $name;
+ if(@list == 0){
+ return;
+ }
+ elsif(@list == 1){
+ return ($len, $list[0]);
+ }
+ else{
+ return ($len, _find_or_create_union_type(@list));
}
+}
- # enum size => 'small', 'medium', 'large'
- my $name = shift;
- my %is_valid = map { $_ => 1 } @_;
- subtype(
- $name => where => sub { $is_valid{$_} }
- );
+sub find_type_constraint {
+ my($spec) = @_;
+ return $spec if _is_a_type_constraint($spec);
+
+ $spec =~ s/\s+//g;
+ return $TYPE{$spec};
}
-sub _build_type_constraint {
+sub find_or_parse_type_constraint {
+ my($spec) = @_;
+ return $spec if _is_a_type_constraint($spec);
- 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);
- }
- 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");
- }
- $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 Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $spec );
+ return $TYPE{$spec} || do{
+ my($pos, $type) = _parse_type($spec, 0);
+ $type;
+ };
}
-sub find_type_constraint {
- my $type_constraint = shift;
- return $TYPE{$type_constraint};
+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(@_);
}
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,
- );
- }
- }
- return $code;
+ # XXX: Moose does not register a new class_type, but Mouse does.
+ return find_or_parse_type_constraint(@_) || class_type(@_);
}
1;
Mouse::Util::TypeConstraints - Type constraint system for Mouse
+=head1 VERSION
+
+This document describes Mouse version 0.40_02
+
=head2 SYNOPSIS
use Mouse::Util::TypeConstraints;
GlobRef
FileHandle
Object
- Role
B<NOTE:> Any type followed by a type parameter C<[`a]> can be
parameterized, this means you can say:
=head1 METHODS
-=head2 optimized_constraints -> HashRef[CODE]
+=head2 C<< list_all_builtin_type_constraints -> (Names) >>
+
+Returns the names of builtin type constraints.
-Returns the simple type constraints that Mouse understands.
+=head2 C<< list_all_type_constraints -> (Names) >>
+
+Returns the names of all the type constraints.
=head1 FUNCTIONS
=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
projects / gitmo/Mouse.git / blobdiff