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 qw(confess);
+use Scalar::Util ();
-use Carp ();
-use Scalar::Util qw/blessed looks_like_number openhandle/;
use Mouse::Meta::TypeConstraint;
+use Mouse::Exporter;
+
+Mouse::Exporter->setup_import_methods(
+ as_is => [qw(
+ as where message optimize_as
+ from via
+
+ type subtype class_type role_type duck_type
+ enum
+ coerce
-our @EXPORT = qw(
- as where message from via type subtype coerce class_type role_type enum
- find_type_constraint
+ find_type_constraint
+ )],
);
my %TYPE;
-my %TYPE_SOURCE;
-my %COERCE;
-my %COERCE_KEYS;
-sub as ($) {
- as => $_[0]
-}
-sub where (&) {
- where => $_[0]
-}
-sub message (&) {
- message => $_[0]
-}
+# The root type
+$TYPE{Any} = Mouse::Meta::TypeConstraint->new(
+ name => 'Any',
+);
-sub from { @_ }
-sub via (&) {
- $_[0]
-}
+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,
+);
-BEGIN {
- no warnings 'uninitialized';
- %TYPE = (
- Any => sub { 1 },
- Item => sub { 1 },
- Bool => sub {
- !defined($_[0]) || $_[0] eq "" || "$_[0]" eq '1' || "$_[0]" eq '0'
- },
- 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' },
- 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' },
+
+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 %TYPE) {
- $TYPE{$name} = Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $name );
- }
+}
- sub optimized_constraints { \%TYPE }
- my @TYPE_KEYS = keys %TYPE;
- sub list_all_builtin_type_constraints { @TYPE_KEYS }
+# make it parametarizable
- @TYPE_SOURCE{@TYPE_KEYS} = (__PACKAGE__) x @TYPE_KEYS;
-}
+$TYPE{Maybe} {constraint_generator} = \&_parameterize_Maybe_for;
+$TYPE{ArrayRef}{constraint_generator} = \&_parameterize_ArrayRef_for;
+$TYPE{HashRef} {constraint_generator} = \&_parameterize_HashRef_for;
-sub type {
- 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 = $conf{where} || do {
- my $as = delete $conf{as} || 'Any';
- if (! exists $TYPE{$as}) {
- $TYPE{$as} = _build_type_constraint($as);
- }
- $TYPE{$as};
- };
+# sugars
- $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])
- }
- }
- );
-}
+sub as ($) { (as => $_[0]) }
+sub where (&) { (where => $_[0]) }
+sub message (&) { (message => $_[0]) }
+sub optimize_as (&) { (optimize_as => $_[0]) }
-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');
+sub from { @_ }
+sub via (&) { $_[0] }
- $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
- );
+# type utilities
- return $name;
+sub optimized_constraints { # DEPRECATED
+ Carp::cluck('optimized_constraints() has been deprecated');
+ return \%TYPE;
}
-sub coerce {
- my($name, %conf) = @_;
+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;
+
+ my $name;
+ my %args;
+
+ 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 = @_;
+ }
- Carp::croak "Cannot find type '$name', perhaps you forgot to load it."
- unless $TYPE{$name};
+ if(!defined $name){
+ $name = $args{name};
+ }
- unless ($COERCE{$name}) {
- $COERCE{$name} = {};
- $COERCE_KEYS{$name} = [];
+ $args{name} = $name;
+ my $parent;
+ if($mode eq 'subtype'){
+ $parent = delete $args{as};
+ if(!$parent){
+ $parent = delete $args{name};
+ $name = undef;
+ }
}
- while (my($type, $code) = each %conf) {
- Carp::croak "A coercion action already exists for '$type'"
- if $COERCE{$name}->{$type};
-
- 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(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;
}
}
- unshift @{ $COERCE_KEYS{$name} }, $type;
- $COERCE{$name}->{$type} = $code;
+ 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};
+ $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);
+ }
+
+ if(defined $name){
+ return $TYPE{$name} = $constraint;
+ }
+ else{
+ return $constraint;
}
}
+sub type {
+ return _create_type('type', @_);
+}
+
+sub subtype {
+ return _create_type('subtype', @_);
+}
+
+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, $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, $options) = @_;
+ my $class = $options->{class} || $name;
+
+ # ClassType
+ return _create_type 'subtype', $name => (
+ as => 'Object',
+ optimized_as => Mouse::Util::generate_isa_predicate_for($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($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) },
);
}
-# 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($_);
- }
+sub duck_type {
+ my($name, @methods);
+
+ if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){
+ $name = shift;
}
- return $value;
+
+ @methods = (@_ == 1 && ref($_[0]) eq 'ARRAY') ? @{$_[0]} : @_;
+
+ # DuckType
+ return _create_type 'type', $name => (
+ optimized_as => Mouse::Util::generate_can_predicate_for(\@methods),
+ );
}
-my $serial_enum = 0;
sub enum {
- # enum ['small', 'medium', 'large']
- if (ref($_[0]) eq 'ARRAY') {
- my @elements = @{ shift @_ };
-
- my $name = 'Mouse::Util::TypeConstaints::Enum::Serial::'
- . ++$serial_enum;
- enum($name, @elements);
- return $name;
+ my($name, %valid);
+
+ if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){
+ $name = shift;
}
- # enum size => 'small', 'medium', 'large'
- my $name = shift;
- my %is_valid = map { $_ => 1 } @_;
+ %valid = map{ $_ => undef } (@_ == 1 && ref($_[0]) eq 'ARRAY' ? @{$_[0]} : @_);
- subtype(
- $name => where => sub { $is_valid{$_} }
+ # EnumType
+ return _create_type 'type', $name => (
+ optimized_as => sub{ defined($_[0]) && !ref($_[0]) && exists $valid{$_[0]} },
);
}
-sub _build_type_constraint {
+sub _find_or_create_regular_type{
+ my($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);
+ return $TYPE{$spec} if exists $TYPE{$spec};
+
+ my $meta = Mouse::Util::get_metaclass_by_name($spec)
+ or return undef;
+
+ if(Mouse::Util::is_a_metarole($meta)){
+ return role_type($spec);
+ }
+ else{
+ return class_type($spec);
+ }
+}
+
+sub _find_or_create_parameterized_type{
+ my($base, $param) = @_;
+
+ my $name = sprintf '%s[%s]', $base->name, $param->name;
+
+ $TYPE{$name} ||= $base->parameterize($param, $name);
+}
+
+sub _find_or_create_union_type{
+ my @types = sort map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
+
+ my $name = join '|', @types;
+
+ # UnionType
+ $TYPE{$name} ||= Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ type_constraints => \@types,
+ );
+}
+
+# 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);
}
- 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");
+ 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;
+ }
+ }
+ if($i - $start){
+ my $type = _find_or_create_regular_type( substr $spec, $start, $i - $start );
+
+ if(defined $type){
+ push @list, $type;
}
- $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 );
+ elsif($start != 0) {
+ # RT #50421
+ # create a new class type
+ push @list, class_type( substr $spec, $start, $i - $start );
}
}
- return Mouse::Meta::TypeConstraint->new( _compiled_type_constraint => $code, name => $spec );
+
+ 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 $type_constraint = shift;
- return $TYPE{$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);
+ $type;
+ };
+}
+
+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;
-
- 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;
-
__END__
=head1 NAME
Mouse::Util::TypeConstraints - Type constraint system for Mouse
+=head1 VERSION
+
+This document describes Mouse version 0.50_03
+
=head2 SYNOPSIS
use Mouse::Util::TypeConstraints;
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]
CodeRef
RegexpRef
GlobRef
- FileHandle
+ 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.
+
+=head2 C<< list_all_type_constraints -> (Names) >>
-Returns the simple type constraints that Mouse understands.
+Returns the names of all the type constraints.
=head1 FUNCTIONS
=over 4
-=item B<subtype 'Name' => as 'Parent' => where { } ...>
+=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<< class_type ($class, ?$options) -> Mouse::Meta::TypeConstraint >>
+
+=item C<< role_type ($role, ?$options) -> Mouse::Meta::TypeConstraint >>
-=item B<subtype as 'Parent' => where { } ...>
+=item C<< duck_type($name, @methods | \@methods) -> Mouse::Meta::TypeConstraint >>
-=item B<class_type ($class, ?$options)>
+=item C<< duck_type(\@methods) -> Mouse::Meta::TypeConstraint >>
-=item B<role_type ($role, ?$options)>
+=item C<< enum($name, @values | \@values) -> Mouse::Meta::TypeConstraint >>
-=item B<enum (\@values)>
+=item C<< enum (\@values) -> Mouse::Meta::TypeConstraint >>
+
+=item C<< coerce $type => from $another_type, via { }, ... >>
+
+=back
+
+=over 4
+
+=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