package Mouse::Util::TypeConstraints;
-use strict;
-use warnings;
-
-use Exporter;
+use Mouse::Util qw(does_role not_supported); # enables strict and warnings
use Carp qw(confess);
-use Scalar::Util qw/blessed looks_like_number openhandle/;
+use Scalar::Util ();
-use Mouse::Util qw(does_role not_supported);
-use Mouse::Meta::Module; # class_of
use Mouse::Meta::TypeConstraint;
+use Mouse::Exporter;
+
+Mouse::Exporter->setup_import_methods(
+ as_is => [qw(
+ as where message optimize_as
+ from via
-use constant _DEBUG => !!$ENV{TC_DEBUG};
+ type subtype class_type role_type duck_type
+ enum
+ coerce
-our @ISA = qw(Exporter);
-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 %COERCE;
-my %COERCE_KEYS;
-sub as ($) {
- return(as => $_[0]);
-}
-sub where (&) {
- return(where => $_[0])
-}
-sub message (&) {
- return(message => $_[0])
-}
+# The root type
+$TYPE{Any} = Mouse::Meta::TypeConstraint->new(
+ name => 'Any',
+);
+
+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,
+);
-sub from { @_ }
-sub via (&) { $_[0] }
-BEGIN {
- 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]) },
- 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') },
+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 {
- 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]) }
+sub where (&) { (where => $_[0]) }
+sub message (&) { (message => $_[0]) }
+sub optimize_as (&) { (optimize_as => $_[0]) }
+
+sub from { @_ }
+sub via (&) { $_[0] }
+
+# 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){
- if(!defined($name = $args{name})){
- $name = '__ANON__';
- }
+ $name = $args{name};
}
$args{name} = $name;
+ my $parent;
+ if($mode eq 'subtype'){
+ $parent = delete $args{as};
+ if(!$parent){
+ $parent = delete $args{name};
+ $name = undef;
+ }
+ }
- my $package_defined_in = $args{package_defined_in} ||= caller(1);
+ 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;
+ }
+ }
- 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");
+ 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{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 = delete($args{as})
- or confess('A subtype cannot consist solely of a name, it must have a parent');
-
$constraint = find_or_create_isa_type_constraint($parent)->create_child_type(%args);
}
else{
$constraint = Mouse::Meta::TypeConstraint->new(%args);
}
- return $TYPE{$name} = $constraint;
+ if(defined $name){
+ return $TYPE{$name} = $constraint;
+ }
+ else{
+ return $constraint;
+ }
}
sub type {
}
sub coerce {
- my $name = shift;
+ my $type_name = shift;
- $name =~ s/\s+//g;
- confess "Cannot find type '$name', perhaps you forgot to load it."
- unless $TYPE{$name};
+ my $type = find_type_constraint($type_name)
+ or confess("Cannot find type '$type_name', perhaps you forgot to load it.");
- unless ($COERCE{$name}) {
- $COERCE{$name} = {};
- $COERCE_KEYS{$name} = [];
- }
-
- my $package_defined_in = caller;
-
- 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}->{$from} = $action;
- }
+ $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}'?";
- _create_type 'type', $name => (
- as => $conf->{class},
-
- type => 'Class',
- );
- }
- else {
- _create_type 'type', $name => (
- optimized_as => sub { blessed($_[0]) && $_[0]->isa($name) },
+ my($name, $options) = @_;
+ my $class = $options->{class} || $name;
- type => 'Class',
- );
- }
+ # 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 && $conf->{role}) ? $conf->{role} : $name;
- _create_type 'type', $name => (
- optimized_as => sub { blessed($_[0]) && does_role($_[0], $role) },
+ my($name, $options) = @_;
+ my $role = $options->{role} || $name;
- type => 'Role',
+ # 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;
+sub duck_type {
+ my($name, @methods);
- local $_;
- 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;
- my $coerced = $COERCE{$type}->{$coerce_type}->($value); # coerce
+ if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){
+ $name = shift;
+ }
- if(_DEBUG){
- warn sprintf "# COERCE: got %s, which is%s %s\n",
- defined($coerced) ? $coerced : 'undef', $types->check($coerced) ? '' : ' not', $types;
- }
+ @methods = (@_ == 1 && ref($_[0]) eq 'ARRAY') ? @{$_[0]} : @_;
- # check with $types, not $constraint
- return $coerced if $types->check($coerced);
- }
- }
- return $value; # returns original $value
+ # DuckType
+ return _create_type 'type', $name => (
+ optimized_as => Mouse::Util::generate_can_predicate_for(\@methods),
+ );
}
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{
- $name = shift;
- %valid = map{ $_ => undef } @_;
+ if(!(@_ == 1 && ref($_[0]) eq 'ARRAY')){
+ $name = shift;
}
+
+ %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]} },
-
- type => 'Enum',
);
}
return $TYPE{$spec} if exists $TYPE{$spec};
- my $meta = Mouse::Meta::Module::class_of($spec);
-
- if(!$meta){
- return;
- }
+ my $meta = Mouse::Util::get_metaclass_by_name($spec)
+ or return undef;
- my $check;
- my $type;
- if($meta->isa('Mouse::Meta::Role')){
- $check = sub{
- return blessed($_[0]) && $_[0]->does($spec);
- };
- $type = 'Role';
+ if(Mouse::Util::is_a_metarole($meta)){
+ return role_type($spec);
}
else{
- $check = sub{
- return blessed($_[0]) && $_[0]->isa($spec);
- };
- $type = 'Class';
+ return class_type($spec);
}
-
- warn "#CREATE a $type type for $spec\n" if _DEBUG;
-
- return $TYPE{$spec} = Mouse::Meta::TypeConstraint->new(
- name => $spec,
- optimized => $check,
-
- type => $type,
- );
}
-$TYPE{ArrayRef}{constraint_generator} = sub {
- my($type_parameter) = @_;
- my $check = $type_parameter->_compiled_type_constraint;
-
- 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;
- };
-};
-
-# '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',
- );
- }
+ $TYPE{$name} ||= $base->parameterize($param, $name);
}
-sub _find_or_create_union_type{
- my @types = map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
- my $name = join '|', map{ $_->name } @types;
-
- $TYPE{$name} ||= do{
- warn "# CREATE a Union type for ", Mouse::Util::english_list(@types),"\n" if _DEBUG;
+sub _find_or_create_union_type{
+ my @types = sort map{ $_->{type_constraints} ? @{$_->{type_constraints}} : $_ } @_;
- return Mouse::Meta::TypeConstraint->new(
- name => $name,
- type_constraints => \@types,
+ my $name = join '|', @types;
- type => 'Union',
- );
- };
+ # UnionType
+ $TYPE{$name} ||= Mouse::Meta::TypeConstraint->new(
+ name => $name,
+ type_constraints => \@types,
+ );
}
# The type parser
}
}
if($i - $start){
- push @list, _find_or_create_regular_type(substr $spec, $start, $i - $start);
+ my $type = _find_or_create_regular_type( substr $spec, $start, $i - $start );
+
+ 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 );
+ }
}
if(@list == 0){
sub find_type_constraint {
my($spec) = @_;
- return $spec if blessed($spec) && $spec->isa('Mouse::Meta::TypeConstraint');
+ 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 blessed($spec) && $spec->isa('Mouse::Meta::TypeConstraint');
+ return $spec if Mouse::Util::is_a_type_constraint($spec);
+ return undef if !defined $spec;
$spec =~ s/\s+//g;
return $TYPE{$spec} || do{
}
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;
+ # 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 {
+ # 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
B<NOTE:> Any type followed by a type parameter C<[`a]> can be
=over 4
-=item C<< subtype 'Name' => as 'Parent' => where { } ... -> Mouse::Meta::TypeConstraint >>
+=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<< 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 C<< duck_type($name, @methods | \@methods) -> Mouse::Meta::TypeConstraint >>
+
+=item C<< duck_type(\@methods) -> Mouse::Meta::TypeConstraint >>
+
+=item C<< enum($name, @values | \@values) -> Mouse::Meta::TypeConstraint >>
+
=item C<< enum (\@values) -> Mouse::Meta::TypeConstraint >>
+=item C<< coerce $type => from $another_type, via { }, ... >>
+
=back
=over 4
projects / gitmo/Mouse.git / blobdiff