[gitmo/Mouse.git] / lib / Mouse / PurePerl.pm

package Mouse::PurePerl;
# The pure Perl backend for Mouse
package Mouse::Util;
use strict;
use warnings;
use warnings FATAL => 'redefine'; # to avoid to load Mouse::PurePerl twice

use B ();

require Mouse::Util;


# taken from Class/MOP.pm
sub is_valid_class_name {
    my $class = shift;

    return 0 if ref($class);
    return 0 unless defined($class);

    return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;

    return 0;
}

sub is_class_loaded {
    my $class = shift;

    return 0 if ref($class) || !defined($class) || !length($class);

    # walk the symbol table tree to avoid autovififying
    # \*{${main::}{"Foo::"}{"Bar::"}} == \*main::Foo::Bar::

    my $pack = \%::;
    foreach my $part (split('::', $class)) {
        $part .= '::';
        return 0 if !exists $pack->{$part};

        my $entry = \$pack->{$part};
        return 0 if ref($entry) ne 'GLOB';
        $pack = *{$entry}{HASH};
    }

    return 0 if !%{$pack};

    # check for $VERSION or @ISA
    return 1 if exists $pack->{VERSION}
             && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
    return 1 if exists $pack->{ISA}
             && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;

    # check for any method
    foreach my $name( keys %{$pack} ) {
        my $entry = \$pack->{$name};
        return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE};
    }

    # fail
    return 0;
}


# taken from Sub::Identify
sub get_code_info {
    my ($coderef) = @_;
    ref($coderef) or return;

    my $cv = B::svref_2object($coderef);
    $cv->isa('B::CV') or return;

    my $gv = $cv->GV;
    $gv->isa('B::GV') or return;

    return ($gv->STASH->NAME, $gv->NAME);
}

sub get_code_package{
    my($coderef) = @_;

    my $cv = B::svref_2object($coderef);
    $cv->isa('B::CV') or return '';

    my $gv = $cv->GV;
    $gv->isa('B::GV') or return '';

    return $gv->STASH->NAME;
}

sub get_code_ref{
    my($package, $name) = @_;
    no strict 'refs';
    no warnings 'once';
    use warnings FATAL => 'uninitialized';
    return *{$package . '::' . $name}{CODE};
}

sub generate_isa_predicate_for {
    my($for_class, $name) = @_;

    my $predicate = sub{ Scalar::Util::blessed($_[0]) && $_[0]->isa($for_class) };

    if(defined $name){
        Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
        return;
    }

    return $predicate;
}

sub generate_can_predicate_for {
    my($methods_ref, $name) = @_;

    my @methods = @{$methods_ref};

    my $predicate = sub{
        my($instance) = @_;
        if(Scalar::Util::blessed($instance)){
            foreach my $method(@methods){
                if(!$instance->can($method)){
                    return 0;
                }
            }
            return 1;
        }
        return 0;
    };

    if(defined $name){
        Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
        return;
    }

    return $predicate;
}

package Mouse::Util::TypeConstraints;

use Scalar::Util qw(blessed looks_like_number openhandle);

sub Any        { 1 }
sub Item       { 1 }

sub Bool       { $_[0] ? $_[0] eq '1' : 1 }
sub Undef      { !defined($_[0]) }
sub Defined    {  defined($_[0])  }
sub Value      {  defined($_[0]) && !ref($_[0]) }
sub Num        {  looks_like_number($_[0]) }
sub Int        {
    my($value) = @_;
    looks_like_number($value) && $value =~ /\A [+-]? [0-9]+  \z/xms;
}
sub Str        {
    my($value) = @_;
    return defined($value) && ref(\$value) eq 'SCALAR';
}

sub Ref        { ref($_[0]) }
sub ScalarRef  {
    my($value) = @_;
    return ref($value) eq 'SCALAR' || ref($value) eq 'REF';
}
sub ArrayRef   { ref($_[0]) eq 'ARRAY'  }
sub HashRef    { ref($_[0]) eq 'HASH'   }
sub CodeRef    { ref($_[0]) eq 'CODE'   }
sub RegexpRef  { ref($_[0]) eq 'Regexp' }
sub GlobRef    { ref($_[0]) eq 'GLOB'   }

sub FileHandle {
    return openhandle($_[0])  || (blessed($_[0]) && $_[0]->isa("IO::Handle"))
}

sub Object     { blessed($_[0]) && blessed($_[0]) ne 'Regexp' }

sub ClassName  { Mouse::Util::is_class_loaded($_[0]) }
sub RoleName   { (Mouse::Util::class_of($_[0]) || return 0)->isa('Mouse::Meta::Role') }

sub _parameterize_ArrayRef_for {
    my($type_parameter) = @_;
    my $check = $type_parameter->_compiled_type_constraint;

    return sub {
        foreach my $value (@{$_}) {
            return undef unless $check->($value);
        }
        return 1;
    }
}

sub _parameterize_HashRef_for {
    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
sub _parameterize_Maybe_for {
    my($type_parameter) = @_;
    my $check = $type_parameter->_compiled_type_constraint;

    return sub{
        return !defined($_) || $check->($_);
    };
}

package Mouse::Meta::Module;

sub name          { $_[0]->{package} }

sub _method_map   { $_[0]->{methods} }
sub _attribute_map{ $_[0]->{attributes} }

sub namespace{
    my $name = $_[0]->{package};
    no strict 'refs';
    return \%{ $name . '::' };
}

sub add_method {
    my($self, $name, $code) = @_;

    if(!defined $name){
        $self->throw_error('You must pass a defined name');
    }
    if(!defined $code){
        $self->throw_error('You must pass a defined code');
    }

    if(ref($code) ne 'CODE'){
        $code = \&{$code}; # coerce
    }

    $self->{methods}->{$name} = $code; # Moose stores meta object here.

    Mouse::Util::install_subroutines($self->name,
        $name => $code,
    );
    return;
}

my $generate_class_accessor = sub {
    my($name) = @_;
    return sub {
        my $self = shift;
        if(@_) {
            return $self->{$name} = shift;
        }

        foreach my $class($self->linearized_isa) {
            my $meta = Mouse::Util::get_metaclass_by_name($class)
                or next;

            if(exists $meta->{$name}) {
                return $meta->{$name};
            }
        }
        return undef;
    };
};


package Mouse::Meta::Class;

use Mouse::Meta::Method::Constructor;
use Mouse::Meta::Method::Destructor;

sub method_metaclass    { $_[0]->{method_metaclass}    || 'Mouse::Meta::Method'    }
sub attribute_metaclass { $_[0]->{attribute_metaclass} || 'Mouse::Meta::Attribute' }

sub constructor_class { $_[0]->{constructor_class} || 'Mouse::Meta::Method::Constructor' }
sub destructor_class  { $_[0]->{destructor_class}  || 'Mouse::Meta::Method::Destructor'  }

sub is_anon_class{
    return exists $_[0]->{anon_serial_id};
}

sub roles { $_[0]->{roles} }

sub linearized_isa { @{ Mouse::Util::get_linear_isa($_[0]->{package}) } }

sub new_object {
    my $meta = shift;
    my %args = (@_ == 1 ? %{$_[0]} : @_);

    my $object = bless {}, $meta->name;

    $meta->_initialize_object($object, \%args, 0);
    # BUILDALL
    if( $object->can('BUILD') ) {
        for my $class (reverse $meta->linearized_isa) {
            my $build = Mouse::Util::get_code_ref($class, 'BUILD')
                || next;

            $object->$build(\%args);
        }
    }
    return $object;
}

sub clone_object {
    my $class  = shift;
    my $object = shift;
    my $args   = $object->Mouse::Object::BUILDARGS(@_);

    (blessed($object) && $object->isa($class->name))
        || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");

    my $cloned = bless { %$object }, ref $object;
    $class->_initialize_object($cloned, $args, 1);
    return $cloned;
}

sub _initialize_object{
    my($self, $object, $args, $is_cloning) = @_;
    # The initializer, which is used everywhere, must be clear
    # when an attribute is added. See Mouse::Meta::Class::add_attribute.
    my $initializer = $self->{_mouse_cache}{_initialize_object} ||=
        Mouse::Util::load_class($self->constructor_class)
            ->_generate_initialize_object($self);
    goto &{$initializer};
}

sub get_all_attributes {
    my($self) = @_;
    return @{ $self->{_mouse_cache}{all_attributes}
        ||= $self->_calculate_all_attributes };
}

sub is_immutable {  $_[0]->{is_immutable} }

sub strict_constructor;
*strict_constructor = $generate_class_accessor->('strict_constructor');

sub _report_unknown_args {
    my($metaclass, $attrs, $args) = @_;

    my @unknowns;
    my %init_args;
    foreach my $attr(@{$attrs}){
        my $init_arg = $attr->init_arg;
        if(defined $init_arg){
            $init_args{$init_arg}++;
        }
    }

    while(my $key = each %{$args}){
        if(!exists $init_args{$key}){
            push @unknowns, $key;
        }
    }

    $metaclass->throw_error( sprintf
        "Unknown attribute passed to the constructor of %s: %s",
        $metaclass->name, Mouse::Util::english_list(@unknowns),
    );
}

package Mouse::Meta::Role;

sub method_metaclass{ $_[0]->{method_metaclass} || 'Mouse::Meta::Role::Method' }

sub is_anon_role{
    return exists $_[0]->{anon_serial_id};
}

sub get_roles { $_[0]->{roles} }

sub add_before_method_modifier {
    my ($self, $method_name, $method) = @_;

    push @{ $self->{before_method_modifiers}{$method_name} ||= [] }, $method;
    return;
}
sub add_around_method_modifier {
    my ($self, $method_name, $method) = @_;

    push @{ $self->{around_method_modifiers}{$method_name} ||= [] }, $method;
    return;
}
sub add_after_method_modifier {
    my ($self, $method_name, $method) = @_;

    push @{ $self->{after_method_modifiers}{$method_name} ||= [] }, $method;
    return;
}

sub get_before_method_modifiers {
    my ($self, $method_name) = @_;
    return @{ $self->{before_method_modifiers}{$method_name} ||= [] }
}
sub get_around_method_modifiers {
    my ($self, $method_name) = @_;
    return @{ $self->{around_method_modifiers}{$method_name} ||= [] }
}
sub get_after_method_modifiers {
    my ($self, $method_name) = @_;
    return @{ $self->{after_method_modifiers}{$method_name} ||= [] }
}

sub add_metaclass_accessor { # for meta roles (a.k.a. traits)
    my($meta, $name) = @_;
    $meta->add_method($name => $generate_class_accessor->($name));
    return;
}

package Mouse::Meta::Attribute;

require Mouse::Meta::Method::Accessor;

sub accessor_metaclass{ $_[0]->{accessor_metaclass} || 'Mouse::Meta::Method::Accessor' }

# readers

sub name                 { $_[0]->{name}                   }
sub associated_class     { $_[0]->{associated_class}       }

sub accessor             { $_[0]->{accessor}               }
sub reader               { $_[0]->{reader}                 }
sub writer               { $_[0]->{writer}                 }
sub predicate            { $_[0]->{predicate}              }
sub clearer              { $_[0]->{clearer}                }
sub handles              { $_[0]->{handles}                }

sub _is_metadata         { $_[0]->{is}                     }
sub is_required          { $_[0]->{required}               }
sub default              { $_[0]->{default}                }
sub is_lazy              { $_[0]->{lazy}                   }
sub is_lazy_build        { $_[0]->{lazy_build}             }
sub is_weak_ref          { $_[0]->{weak_ref}               }
sub init_arg             { $_[0]->{init_arg}               }
sub type_constraint      { $_[0]->{type_constraint}        }

sub trigger              { $_[0]->{trigger}                }
sub builder              { $_[0]->{builder}                }
sub should_auto_deref    { $_[0]->{auto_deref}             }
sub should_coerce        { $_[0]->{coerce}                 }

sub documentation        { $_[0]->{documentation}          }
sub insertion_order      { $_[0]->{insertion_order}        }

# predicates

sub has_accessor         { exists $_[0]->{accessor}        }
sub has_reader           { exists $_[0]->{reader}          }
sub has_writer           { exists $_[0]->{writer}          }
sub has_predicate        { exists $_[0]->{predicate}       }
sub has_clearer          { exists $_[0]->{clearer}         }
sub has_handles          { exists $_[0]->{handles}         }

sub has_default          { exists $_[0]->{default}         }
sub has_type_constraint  { exists $_[0]->{type_constraint} }
sub has_trigger          { exists $_[0]->{trigger}         }
sub has_builder          { exists $_[0]->{builder}         }

sub has_documentation    { exists $_[0]->{documentation}   }

sub _process_options{
    my($class, $name, $args) = @_;

    # taken from Class::MOP::Attribute::new

    defined($name)
        or $class->throw_error('You must provide a name for the attribute');

    if(!exists $args->{init_arg}){
        $args->{init_arg} = $name;
    }

    # 'required' requires eigher 'init_arg', 'builder', or 'default'
    my $can_be_required = defined( $args->{init_arg} );

    if(exists $args->{builder}){
        # XXX:
        # Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility
        # This feature will be changed in a future. (gfx)
        $class->throw_error('builder must be a defined scalar value which is a method name')
            #if ref $args->{builder} || !defined $args->{builder};
            if !defined $args->{builder};

        $can_be_required++;
    }
    elsif(exists $args->{default}){
        if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
            $class->throw_error("References are not allowed as default values, you must "
                              . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
        }
        $can_be_required++;
    }

    if( $args->{required} && !$can_be_required ) {
        $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
    }

    # taken from Mouse::Meta::Attribute->new and ->_process_args

    if(exists $args->{is}){
        my $is = $args->{is};

        if($is eq 'ro'){
            $args->{reader} ||= $name;
        }
        elsif($is eq 'rw'){
            if(exists $args->{writer}){
                $args->{reader} ||= $name;
             }
             else{
                $args->{accessor} ||= $name;
             }
        }
        elsif($is eq 'bare'){
            # do nothing, but don't complain (later) about missing methods
        }
        else{
            $is = 'undef' if !defined $is;
            $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
        }
    }

    my $tc;
    if(exists $args->{isa}){
        $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
    }

    if(exists $args->{does}){
        if(defined $tc){ # both isa and does supplied
            my $does_ok = do{
                local $@;
                eval{ "$tc"->does($args) };
            };
            if(!$does_ok){
                $class->throw_error("Cannot have both an isa option and a does option because '$tc' does not do '$args->{does}' on attribute ($name)");
            }
        }
        else {
            $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
        }
    }

    if($args->{coerce}){
        defined($tc)
            || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");

        $args->{weak_ref}
            && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
    }

    if ($args->{lazy_build}) {
        exists($args->{default})
            && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");

        $args->{lazy}      = 1;
        $args->{builder} ||= "_build_${name}";
        if ($name =~ /^_/) {
            $args->{clearer}   ||= "_clear${name}";
            $args->{predicate} ||= "_has${name}";
        }
        else {
            $args->{clearer}   ||= "clear_${name}";
            $args->{predicate} ||= "has_${name}";
        }
    }

    if ($args->{auto_deref}) {
        defined($tc)
            || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");

        ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') )
            || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
    }

    if (exists $args->{trigger}) {
        ('CODE' eq ref $args->{trigger})
            || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
    }

    if ($args->{lazy}) {
        (exists $args->{default} || defined $args->{builder})
            || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
    }

    return;
}


package Mouse::Meta::TypeConstraint;

use overload
    '""' => '_as_string',
    '0+' => '_identity',
    '|'  => '_unite',

    fallback => 1;

sub name    { $_[0]->{name}    }
sub parent  { $_[0]->{parent}  }
sub message { $_[0]->{message} }

sub _identity  { Scalar::Util::refaddr($_[0]) } # overload 0+

sub type_parameter           { $_[0]->{type_parameter} }
sub _compiled_type_constraint{ $_[0]->{compiled_type_constraint} }
sub _compiled_type_coercion  { $_[0]->{_compiled_type_coercion}  }

sub __is_parameterized { exists $_[0]->{type_parameter} }
sub has_coercion {       exists $_[0]->{_compiled_type_coercion} }


sub compile_type_constraint{
    my($self) = @_;

    # add parents first
    my @checks;
    for(my $parent = $self->{parent}; defined $parent; $parent = $parent->{parent}){
         if($parent->{hand_optimized_type_constraint}){
            unshift @checks, $parent->{hand_optimized_type_constraint};
            last; # a hand optimized constraint must include all the parents
        }
        elsif($parent->{constraint}){
            unshift @checks, $parent->{constraint};
        }
    }

    # then add child
    if($self->{constraint}){
        push @checks, $self->{constraint};
    }

    if($self->{type_constraints}){ # Union
        my @types = map{ $_->{compiled_type_constraint} } @{ $self->{type_constraints} };
        push @checks, sub{
            foreach my $c(@types){
                return 1 if $c->($_[0]);
            }
            return 0;
        };
    }

    if(@checks == 0){
        $self->{compiled_type_constraint} = \&Mouse::Util::TypeConstraints::Any;
    }
    else{
        $self->{compiled_type_constraint} =  sub{
            my(@args) = @_;
            local $_ = $args[0];
            foreach my $c(@checks){
                return undef if !$c->(@args);
            }
            return 1;
        };
    }
    return;
}

sub check {
    my $self = shift;
    return $self->_compiled_type_constraint->(@_);
}


package Mouse::Object;

sub BUILDARGS {
    my $class = shift;

    if (scalar @_ == 1) {
        (ref($_[0]) eq 'HASH')
            || $class->meta->throw_error("Single parameters to new() must be a HASH ref");

        return {%{$_[0]}};
    }
    else {
        return {@_};
    }
}

sub new {
    my $class = shift;
    my $args  = $class->BUILDARGS(@_);
    return $class->meta->new_object($args);
}

sub DESTROY {
    my $self = shift;

    return unless $self->can('DEMOLISH'); # short circuit

    my $e = do{
        local $?;
        local $@;
        eval{
            # DEMOLISHALL

            # We cannot count on being able to retrieve a previously made
            # metaclass, _or_ being able to make a new one during global
            # destruction. However, we should still be able to use mro at
            # that time (at least tests suggest so ;)

            foreach my $class (@{ Mouse::Util::get_linear_isa(ref $self) }) {
                my $demolish = Mouse::Util::get_code_ref($class, 'DEMOLISH')
                    || next;

                $self->$demolish($Mouse::Util::in_global_destruction);
            }
        };
        $@;
    };

    no warnings 'misc';
    die $e if $e; # rethrow
}

sub BUILDALL {
    my $self = shift;

    # short circuit
    return unless $self->can('BUILD');

    for my $class (reverse $self->meta->linearized_isa) {
        my $build = Mouse::Util::get_code_ref($class, 'BUILD')
            || next;

        $self->$build(@_);
    }
    return;
}

sub DEMOLISHALL;
*DEMOLISHALL = \&DESTROY;

1;
__END__

=head1 NAME

Mouse::PurePerl - A Mouse guts in pure Perl

=head1 VERSION

This document describes Mouse version 0.73

=head1 SEE ALSO

L<Mouse::XS>

=cut
Commit	Line	Data
ccb38d0b	1	package Mouse::PurePerl;
4bef84ef	2	# The pure Perl backend for Mouse
6fffa617	3	package Mouse::Util;
df6dd016	4	use strict;
df6dd016	5	use warnings;
4bef84ef	6	use warnings FATAL => 'redefine'; # to avoid to load Mouse::PurePerl twice
df6dd016	7
	8	use B ();
	9
4bef84ef	10	require Mouse::Util;
4bef84ef	11
0ffc4183	12
	13	# taken from Class/MOP.pm
	14	sub is_valid_class_name {
	15	my $class = shift;
	16
	17	return 0 if ref($class);
	18	return 0 unless defined($class);
	19
	20	return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
	21
	22	return 0;
	23	}
	24
df6dd016	25	sub is_class_loaded {
	26	my $class = shift;
	27
	28	return 0 if ref($class) \|\| !defined($class) \|\| !length($class);
	29
	30	# walk the symbol table tree to avoid autovififying
3bb9e54e	31	# \{${main::}{"Foo::"}{"Bar::"}} == \main::Foo::Bar::
df6dd016	32
	33	my $pack = \%::;
	34	foreach my $part (split('::', $class)) {
3bb9e54e	35	$part .= '::';
	36	return 0 if !exists $pack->{$part};
	37
	38	my $entry = \$pack->{$part};
df6dd016	39	return 0 if ref($entry) ne 'GLOB';
3bb9e54e	40	$pack = *{$entry}{HASH};
df6dd016	41	}
df6dd016	42
3bb9e54e	43	return 0 if !%{$pack};
3bb9e54e	44
df6dd016	45	# check for $VERSION or @ISA
	46	return 1 if exists $pack->{VERSION}
	47	&& defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
	48	return 1 if exists $pack->{ISA}
	49	&& defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;
	50
	51	# check for any method
	52	foreach my $name( keys %{$pack} ) {
	53	my $entry = \$pack->{$name};
	54	return 1 if ref($entry) ne 'GLOB' \|\| defined *{$entry}{CODE};
	55	}
	56
	57	# fail
	58	return 0;
	59	}
	60
	61
	62	# taken from Sub::Identify
	63	sub get_code_info {
	64	my ($coderef) = @_;
	65	ref($coderef) or return;
	66
	67	my $cv = B::svref_2object($coderef);
	68	$cv->isa('B::CV') or return;
	69
	70	my $gv = $cv->GV;
	71	$gv->isa('B::GV') or return;
	72
	73	return ($gv->STASH->NAME, $gv->NAME);
	74	}
	75
	76	sub get_code_package{
	77	my($coderef) = @_;
	78
	79	my $cv = B::svref_2object($coderef);
	80	$cv->isa('B::CV') or return '';
	81
	82	my $gv = $cv->GV;
	83	$gv->isa('B::GV') or return '';
	84
	85	return $gv->STASH->NAME;
	86	}
	87
7d96ae4d	88	sub get_code_ref{
	89	my($package, $name) = @_;
	90	no strict 'refs';
	91	no warnings 'once';
	92	use warnings FATAL => 'uninitialized';
	93	return *{$package . '::' . $name}{CODE};
	94	}
	95
e3540312	96	sub generate_isa_predicate_for {
1d5ecd5f	97	my($for_class, $name) = @_;
1d5ecd5f	98
f48920c1	99	my $predicate = sub{ Scalar::Util::blessed($_[0]) && $_[0]->isa($for_class) };
1d5ecd5f	100
1d5ecd5f	101	if(defined $name){
1194aede	102	Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
1d5ecd5f	103	return;
	104	}
	105
	106	return $predicate;
	107	}
	108
ebe91068	109	sub generate_can_predicate_for {
	110	my($methods_ref, $name) = @_;
	111
	112	my @methods = @{$methods_ref};
	113
	114	my $predicate = sub{
	115	my($instance) = @_;
	116	if(Scalar::Util::blessed($instance)){
	117	foreach my $method(@methods){
	118	if(!$instance->can($method)){
	119	return 0;
	120	}
	121	}
	122	return 1;
	123	}
	124	return 0;
	125	};
	126
	127	if(defined $name){
1194aede	128	Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
ebe91068	129	return;
	130	}
	131
	132	return $predicate;
	133	}
1d5ecd5f	134
6fffa617	135	package Mouse::Util::TypeConstraints;
f48920c1	136
	137	use Scalar::Util qw(blessed looks_like_number openhandle);
	138
7d96ae4d	139	sub Any { 1 }
7d96ae4d	140	sub Item { 1 }
7d96ae4d	141
	142	sub Bool { $_[0] ? $_[0] eq '1' : 1 }
	143	sub Undef { !defined($_[0]) }
	144	sub Defined { defined($_[0]) }
	145	sub Value { defined($_[0]) && !ref($_[0]) }
1adf864e	146	sub Num { looks_like_number($_[0]) }
	147	sub Int {
	148	my($value) = @_;
0cfe08a4	149	looks_like_number($value) && $value =~ /\A [+-]? [0-9]+ \z/xms;
1adf864e	150	}
9848d3e1	151	sub Str {
	152	my($value) = @_;
	153	return defined($value) && ref(\$value) eq 'SCALAR';
	154	}
7d96ae4d	155
7d96ae4d	156	sub Ref { ref($_[0]) }
9848d3e1	157	sub ScalarRef {
9848d3e1	158	my($value) = @_;
4068a8f6	159	return ref($value) eq 'SCALAR' \|\| ref($value) eq 'REF';
9848d3e1	160	}
7d96ae4d	161	sub ArrayRef { ref($_[0]) eq 'ARRAY' }
	162	sub HashRef { ref($_[0]) eq 'HASH' }
	163	sub CodeRef { ref($_[0]) eq 'CODE' }
	164	sub RegexpRef { ref($_[0]) eq 'Regexp' }
	165	sub GlobRef { ref($_[0]) eq 'GLOB' }
	166
	167	sub FileHandle {
9848d3e1	168	return openhandle($_[0]) \|\| (blessed($_[0]) && $_[0]->isa("IO::Handle"))
7d96ae4d	169	}
	170
	171	sub Object { blessed($_[0]) && blessed($_[0]) ne 'Regexp' }
	172
	173	sub ClassName { Mouse::Util::is_class_loaded($_[0]) }
	174	sub RoleName { (Mouse::Util::class_of($_[0]) \|\| return 0)->isa('Mouse::Meta::Role') }
	175
619338ac	176	sub _parameterize_ArrayRef_for {
	177	my($type_parameter) = @_;
	178	my $check = $type_parameter->_compiled_type_constraint;
	179
	180	return sub {
	181	foreach my $value (@{$_}) {
	182	return undef unless $check->($value);
	183	}
	184	return 1;
	185	}
	186	}
	187
	188	sub _parameterize_HashRef_for {
	189	my($type_parameter) = @_;
	190	my $check = $type_parameter->_compiled_type_constraint;
	191
	192	return sub {
	193	foreach my $value(values %{$_}){
	194	return undef unless $check->($value);
	195	}
	196	return 1;
	197	};
	198	}
	199
	200	# 'Maybe' type accepts 'Any', so it requires parameters
	201	sub _parameterize_Maybe_for {
	202	my($type_parameter) = @_;
	203	my $check = $type_parameter->_compiled_type_constraint;
	204
	205	return sub{
	206	return !defined($_) \|\| $check->($_);
	207	};
9b923ac8	208	}
7d96ae4d	209
6fffa617	210	package Mouse::Meta::Module;
43165725	211
926404f2	212	sub name { $_[0]->{package} }
	213
	214	sub _method_map { $_[0]->{methods} }
c5f6ad05	215	sub _attribute_map{ $_[0]->{attributes} }
43165725	216
2591e962	217	sub namespace{
	218	my $name = $_[0]->{package};
	219	no strict 'refs';
	220	return \%{ $name . '::' };
	221	}
	222
3e44140b	223	sub add_method {
	224	my($self, $name, $code) = @_;
	225
	226	if(!defined $name){
	227	$self->throw_error('You must pass a defined name');
	228	}
	229	if(!defined $code){
	230	$self->throw_error('You must pass a defined code');
	231	}
	232
	233	if(ref($code) ne 'CODE'){
	234	$code = \&{$code}; # coerce
	235	}
	236
	237	$self->{methods}->{$name} = $code; # Moose stores meta object here.
	238
1194aede	239	Mouse::Util::install_subroutines($self->name,
	240	$name => $code,
	241	);
3e44140b	242	return;
	243	}
	244
b4dc9315	245	my $generate_class_accessor = sub {
	246	my($name) = @_;
	247	return sub {
	248	my $self = shift;
	249	if(@_) {
	250	return $self->{$name} = shift;
	251	}
	252
	253	foreach my $class($self->linearized_isa) {
	254	my $meta = Mouse::Util::get_metaclass_by_name($class)
	255	or next;
	256
	257	if(exists $meta->{$name}) {
	258	return $meta->{$name};
	259	}
	260	}
	261	return undef;
	262	};
	263	};
	264
	265
6fffa617	266	package Mouse::Meta::Class;
43165725	267
e088c5fc	268	use Mouse::Meta::Method::Constructor;
	269	use Mouse::Meta::Method::Destructor;
	270
e058b279	271	sub method_metaclass { $_[0]->{method_metaclass} \|\| 'Mouse::Meta::Method' }
	272	sub attribute_metaclass { $_[0]->{attribute_metaclass} \|\| 'Mouse::Meta::Attribute' }
	273
	274	sub constructor_class { $_[0]->{constructor_class} \|\| 'Mouse::Meta::Method::Constructor' }
	275	sub destructor_class { $_[0]->{destructor_class} \|\| 'Mouse::Meta::Method::Destructor' }
4e7e3250	276
43165725	277	sub is_anon_class{
	278	return exists $_[0]->{anon_serial_id};
	279	}
	280
	281	sub roles { $_[0]->{roles} }
	282
bc76ed1c	283	sub linearized_isa { @{ Mouse::Util::get_linear_isa($_[0]->{package}) } }
cccb83de	284
ba153b33	285	sub new_object {
b5956f03	286	my $meta = shift;
ba153b33	287	my %args = (@_ == 1 ? %{$_[0]} : @_);
ba153b33	288
b5956f03	289	my $object = bless {}, $meta->name;
ba153b33	290
a3a09e38	291	$meta->_initialize_object($object, \%args, 0);
b5956f03	292	# BUILDALL
	293	if( $object->can('BUILD') ) {
	294	for my $class (reverse $meta->linearized_isa) {
	295	my $build = Mouse::Util::get_code_ref($class, 'BUILD')
	296	\|\| next;
	297
	298	$object->$build(\%args);
	299	}
	300	}
ba153b33	301	return $object;
	302	}
	303
13b99908	304	sub clone_object {
	305	my $class = shift;
	306	my $object = shift;
	307	my $args = $object->Mouse::Object::BUILDARGS(@_);
	308
	309	(blessed($object) && $object->isa($class->name))
	310	\|\| $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
	311
	312	my $cloned = bless { %$object }, ref $object;
	313	$class->_initialize_object($cloned, $args, 1);
13b99908	314	return $cloned;
	315	}
	316
4e7e3250	317	sub _initialize_object{
cb6a9721	318	my($self, $object, $args, $is_cloning) = @_;
74de0f8b	319	# The initializer, which is used everywhere, must be clear
74de0f8b	320	# when an attribute is added. See Mouse::Meta::Class::add_attribute.
abbcd124	321	my $initializer = $self->{_mouse_cache}{_initialize_object} \|\|=
a3a09e38	322	Mouse::Util::load_class($self->constructor_class)
a3a09e38	323	->_generate_initialize_object($self);
a3a09e38	324	goto &{$initializer};
4e7e3250	325	}
4e7e3250	326
abbcd124	327	sub get_all_attributes {
	328	my($self) = @_;
	329	return @{ $self->{_mouse_cache}{all_attributes}
	330	\|\|= $self->_calculate_all_attributes };
	331	}
	332
80efe911	333	sub is_immutable { $_[0]->{is_immutable} }
4e7e3250	334
823419c5	335	sub strict_constructor;
823419c5	336	*strict_constructor = $generate_class_accessor->('strict_constructor');
fb4ddd88	337
	338	sub _report_unknown_args {
	339	my($metaclass, $attrs, $args) = @_;
	340
	341	my @unknowns;
	342	my %init_args;
	343	foreach my $attr(@{$attrs}){
	344	my $init_arg = $attr->init_arg;
	345	if(defined $init_arg){
	346	$init_args{$init_arg}++;
	347	}
	348	}
	349
	350	while(my $key = each %{$args}){
	351	if(!exists $init_args{$key}){
	352	push @unknowns, $key;
	353	}
	354	}
	355
	356	$metaclass->throw_error( sprintf
	357	"Unknown attribute passed to the constructor of %s: %s",
	358	$metaclass->name, Mouse::Util::english_list(@unknowns),
	359	);
	360	}
e128626c	361
6fffa617	362	package Mouse::Meta::Role;
43165725	363
e058b279	364	sub method_metaclass{ $_[0]->{method_metaclass} \|\| 'Mouse::Meta::Role::Method' }
e058b279	365
43165725	366	sub is_anon_role{
	367	return exists $_[0]->{anon_serial_id};
	368	}
	369
	370	sub get_roles { $_[0]->{roles} }
	371
cb60d0b5	372	sub add_before_method_modifier {
	373	my ($self, $method_name, $method) = @_;
	374
	375	push @{ $self->{before_method_modifiers}{$method_name} \|\|= [] }, $method;
	376	return;
	377	}
	378	sub add_around_method_modifier {
	379	my ($self, $method_name, $method) = @_;
	380
	381	push @{ $self->{around_method_modifiers}{$method_name} \|\|= [] }, $method;
	382	return;
	383	}
	384	sub add_after_method_modifier {
	385	my ($self, $method_name, $method) = @_;
	386
	387	push @{ $self->{after_method_modifiers}{$method_name} \|\|= [] }, $method;
	388	return;
	389	}
	390
	391	sub get_before_method_modifiers {
	392	my ($self, $method_name) = @_;
	393	return @{ $self->{before_method_modifiers}{$method_name} \|\|= [] }
	394	}
	395	sub get_around_method_modifiers {
	396	my ($self, $method_name) = @_;
	397	return @{ $self->{around_method_modifiers}{$method_name} \|\|= [] }
	398	}
	399	sub get_after_method_modifiers {
	400	my ($self, $method_name) = @_;
	401	return @{ $self->{after_method_modifiers}{$method_name} \|\|= [] }
	402	}
	403
b4dc9315	404	sub add_metaclass_accessor { # for meta roles (a.k.a. traits)
	405	my($meta, $name) = @_;
	406	$meta->add_method($name => $generate_class_accessor->($name));
	407	return;
	408	}
	409
6fffa617	410	package Mouse::Meta::Attribute;
43165725	411
e058b279	412	require Mouse::Meta::Method::Accessor;
	413
	414	sub accessor_metaclass{ $_[0]->{accessor_metaclass} \|\| 'Mouse::Meta::Method::Accessor' }
43165725	415
	416	# readers
	417
	418	sub name { $_[0]->{name} }
	419	sub associated_class { $_[0]->{associated_class} }
	420
	421	sub accessor { $_[0]->{accessor} }
	422	sub reader { $_[0]->{reader} }
	423	sub writer { $_[0]->{writer} }
	424	sub predicate { $_[0]->{predicate} }
	425	sub clearer { $_[0]->{clearer} }
	426	sub handles { $_[0]->{handles} }
	427
	428	sub _is_metadata { $_[0]->{is} }
	429	sub is_required { $_[0]->{required} }
	430	sub default { $_[0]->{default} }
	431	sub is_lazy { $_[0]->{lazy} }
	432	sub is_lazy_build { $_[0]->{lazy_build} }
	433	sub is_weak_ref { $_[0]->{weak_ref} }
	434	sub init_arg { $_[0]->{init_arg} }
	435	sub type_constraint { $_[0]->{type_constraint} }
	436
	437	sub trigger { $_[0]->{trigger} }
	438	sub builder { $_[0]->{builder} }
	439	sub should_auto_deref { $_[0]->{auto_deref} }
	440	sub should_coerce { $_[0]->{coerce} }
	441
d899d3e7	442	sub documentation { $_[0]->{documentation} }
beb51b30	443	sub insertion_order { $_[0]->{insertion_order} }
d899d3e7	444
43165725	445	# predicates
	446
	447	sub has_accessor { exists $_[0]->{accessor} }
	448	sub has_reader { exists $_[0]->{reader} }
	449	sub has_writer { exists $_[0]->{writer} }
	450	sub has_predicate { exists $_[0]->{predicate} }
	451	sub has_clearer { exists $_[0]->{clearer} }
	452	sub has_handles { exists $_[0]->{handles} }
	453
	454	sub has_default { exists $_[0]->{default} }
	455	sub has_type_constraint { exists $_[0]->{type_constraint} }
	456	sub has_trigger { exists $_[0]->{trigger} }
	457	sub has_builder { exists $_[0]->{builder} }
	458
d899d3e7	459	sub has_documentation { exists $_[0]->{documentation} }
d899d3e7	460
ba1f50a2	461	sub _process_options{
	462	my($class, $name, $args) = @_;
	463
	464	# taken from Class::MOP::Attribute::new
	465
	466	defined($name)
	467	or $class->throw_error('You must provide a name for the attribute');
	468
	469	if(!exists $args->{init_arg}){
	470	$args->{init_arg} = $name;
	471	}
	472
	473	# 'required' requires eigher 'init_arg', 'builder', or 'default'
	474	my $can_be_required = defined( $args->{init_arg} );
	475
	476	if(exists $args->{builder}){
	477	# XXX:
	478	# Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility
	479	# This feature will be changed in a future. (gfx)
	480	$class->throw_error('builder must be a defined scalar value which is a method name')
	481	#if ref $args->{builder} \|\| !defined $args->{builder};
	482	if !defined $args->{builder};
	483
	484	$can_be_required++;
	485	}
	486	elsif(exists $args->{default}){
	487	if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
	488	$class->throw_error("References are not allowed as default values, you must "
	489	. "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
	490	}
	491	$can_be_required++;
	492	}
	493
	494	if( $args->{required} && !$can_be_required ) {
	495	$class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
	496	}
	497
	498	# taken from Mouse::Meta::Attribute->new and ->_process_args
	499
	500	if(exists $args->{is}){
	501	my $is = $args->{is};
	502
	503	if($is eq 'ro'){
	504	$args->{reader} \|\|= $name;
	505	}
	506	elsif($is eq 'rw'){
	507	if(exists $args->{writer}){
	508	$args->{reader} \|\|= $name;
	509	}
	510	else{
	511	$args->{accessor} \|\|= $name;
	512	}
	513	}
	514	elsif($is eq 'bare'){
	515	# do nothing, but don't complain (later) about missing methods
	516	}
	517	else{
	518	$is = 'undef' if !defined $is;
	519	$class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
	520	}
	521	}
	522
	523	my $tc;
	524	if(exists $args->{isa}){
d503a4f3	525	$tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
ba1f50a2	526	}
d503a4f3	527
	528	if(exists $args->{does}){
	529	if(defined $tc){ # both isa and does supplied
	530	my $does_ok = do{
	531	local $@;
	532	eval{ "$tc"->does($args) };
	533	};
	534	if(!$does_ok){
	535	$class->throw_error("Cannot have both an isa option and a does option because '$tc' does not do '$args->{does}' on attribute ($name)");
	536	}
	537	}
	538	else {
	539	$tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
	540	}
ba1f50a2	541	}
ba1f50a2	542
	543	if($args->{coerce}){
	544	defined($tc)
	545	\|\| $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
	546
	547	$args->{weak_ref}
	548	&& $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
	549	}
	550
	551	if ($args->{lazy_build}) {
	552	exists($args->{default})
	553	&& $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
	554
	555	$args->{lazy} = 1;
	556	$args->{builder} \|\|= "_build_${name}";
	557	if ($name =~ /^_/) {
	558	$args->{clearer} \|\|= "_clear${name}";
	559	$args->{predicate} \|\|= "_has${name}";
	560	}
	561	else {
	562	$args->{clearer} \|\|= "clear_${name}";
	563	$args->{predicate} \|\|= "has_${name}";
	564	}
	565	}
	566
	567	if ($args->{auto_deref}) {
	568	defined($tc)
	569	\|\| $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
	570
	571	( $tc->is_a_type_of('ArrayRef') \|\| $tc->is_a_type_of('HashRef') )
	572	\|\| $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
	573	}
	574
	575	if (exists $args->{trigger}) {
	576	('CODE' eq ref $args->{trigger})
	577	\|\| $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
	578	}
	579
	580	if ($args->{lazy}) {
	581	(exists $args->{default} \|\| defined $args->{builder})
	582	\|\| $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
	583	}
	584
	585	return;
	586	}
	587
	588
6fffa617	589	package Mouse::Meta::TypeConstraint;
43165725	590
6e647cac	591	use overload
6e647cac	592	'""' => '_as_string',
b4dc9315	593	'0+' => '_identity',
6e647cac	594	'\|' => '_unite',
	595
	596	fallback => 1;
	597
43165725	598	sub name { $_[0]->{name} }
	599	sub parent { $_[0]->{parent} }
	600	sub message { $_[0]->{message} }
	601
f6c81f00	602	sub _identity { Scalar::Util::refaddr($_[0]) } # overload 0+
f6c81f00	603
72dc2c9d	604	sub type_parameter { $_[0]->{type_parameter} }
43165725	605	sub _compiled_type_constraint{ $_[0]->{compiled_type_constraint} }
93540011	606	sub _compiled_type_coercion { $_[0]->{_compiled_type_coercion} }
df6dd016	607
72dc2c9d	608	sub __is_parameterized { exists $_[0]->{type_parameter} }
72dc2c9d	609	sub has_coercion { exists $_[0]->{_compiled_type_coercion} }
df6dd016	610
f790c46b	611
	612	sub compile_type_constraint{
	613	my($self) = @_;
	614
	615	# add parents first
	616	my @checks;
	617	for(my $parent = $self->{parent}; defined $parent; $parent = $parent->{parent}){
	618	if($parent->{hand_optimized_type_constraint}){
	619	unshift @checks, $parent->{hand_optimized_type_constraint};
	620	last; # a hand optimized constraint must include all the parents
	621	}
	622	elsif($parent->{constraint}){
	623	unshift @checks, $parent->{constraint};
	624	}
	625	}
	626
	627	# then add child
	628	if($self->{constraint}){
	629	push @checks, $self->{constraint};
	630	}
	631
	632	if($self->{type_constraints}){ # Union
	633	my @types = map{ $_->{compiled_type_constraint} } @{ $self->{type_constraints} };
	634	push @checks, sub{
	635	foreach my $c(@types){
	636	return 1 if $c->($_[0]);
	637	}
	638	return 0;
	639	};
	640	}
	641
	642	if(@checks == 0){
	643	$self->{compiled_type_constraint} = \&Mouse::Util::TypeConstraints::Any;
	644	}
	645	else{
	646	$self->{compiled_type_constraint} = sub{
	647	my(@args) = @_;
	648	local $_ = $args[0];
	649	foreach my $c(@checks){
	650	return undef if !$c->(@args);
	651	}
	652	return 1;
	653	};
	654	}
	655	return;
	656	}
	657
c7576321	658	sub check {
	659	my $self = shift;
	660	return $self->_compiled_type_constraint->(@_);
	661	}
	662
	663
6fffa617	664	package Mouse::Object;
aa2d2e2c	665
aa2d2e2c	666	sub BUILDARGS {
aa2d2e2c	667	my $class = shift;
f790c46b	668
aa2d2e2c	669	if (scalar @_ == 1) {
	670	(ref($_[0]) eq 'HASH')
	671	\|\| $class->meta->throw_error("Single parameters to new() must be a HASH ref");
	672
	673	return {%{$_[0]}};
	674	}
	675	else {
	676	return {@_};
	677	}
	678	}
f790c46b	679
af04626d	680	sub new {
af04626d	681	my $class = shift;
c83feefa	682	my $args = $class->BUILDARGS(@_);
c83feefa	683	return $class->meta->new_object($args);
af04626d	684	}
af04626d	685
a5c683f6	686	sub DESTROY {
	687	my $self = shift;
	688
	689	return unless $self->can('DEMOLISH'); # short circuit
	690
a5c683f6	691	my $e = do{
a3a09e38	692	local $?;
a5c683f6	693	local $@;
a5c683f6	694	eval{
a5c683f6	695	# DEMOLISHALL
	696
	697	# We cannot count on being able to retrieve a previously made
	698	# metaclass, _or_ being able to make a new one during global
	699	# destruction. However, we should still be able to use mro at
	700	# that time (at least tests suggest so ;)
	701
	702	foreach my $class (@{ Mouse::Util::get_linear_isa(ref $self) }) {
	703	my $demolish = Mouse::Util::get_code_ref($class, 'DEMOLISH')
	704	\|\| next;
	705
6514735e	706	$self->$demolish($Mouse::Util::in_global_destruction);
a5c683f6	707	}
	708	};
	709	$@;
	710	};
	711
	712	no warnings 'misc';
	713	die $e if $e; # rethrow
	714	}
	715
adb5eb76	716	sub BUILDALL {
	717	my $self = shift;
	718
	719	# short circuit
	720	return unless $self->can('BUILD');
	721
	722	for my $class (reverse $self->meta->linearized_isa) {
	723	my $build = Mouse::Util::get_code_ref($class, 'BUILD')
	724	\|\| next;
	725
	726	$self->$build(@_);
	727	}
	728	return;
	729	}
	730
	731	sub DEMOLISHALL;
	732	*DEMOLISHALL = \&DESTROY;
	733
df6dd016	734	1;
df6dd016	735	__END__
ccb38d0b	736
	737	=head1 NAME
	738
	739	Mouse::PurePerl - A Mouse guts in pure Perl
	740
	741	=head1 VERSION
	742
b0d52f03	743	This document describes Mouse version 0.73
ccb38d0b	744
	745	=head1 SEE ALSO
	746
	747	L<Mouse::XS>
	748
	749	=cut