1 package Mouse::PurePerl;
10 use warnings FATAL => 'redefine'; # to avoid to load Mouse::PurePerl
15 # taken from Class/MOP.pm
16 sub is_valid_class_name {
19 return 0 if ref($class);
20 return 0 unless defined($class);
22 return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
30 return 0 if ref($class) || !defined($class) || !length($class);
32 # walk the symbol table tree to avoid autovififying
33 # \*{${main::}{"Foo::"}{"Bar::"}} == \*main::Foo::Bar::
36 foreach my $part (split('::', $class)) {
38 return 0 if !exists $pack->{$part};
40 my $entry = \$pack->{$part};
41 return 0 if ref($entry) ne 'GLOB';
42 $pack = *{$entry}{HASH};
45 return 0 if !%{$pack};
47 # check for $VERSION or @ISA
48 return 1 if exists $pack->{VERSION}
49 && defined *{$pack->{VERSION}}{SCALAR} && defined ${ $pack->{VERSION} };
50 return 1 if exists $pack->{ISA}
51 && defined *{$pack->{ISA}}{ARRAY} && @{ $pack->{ISA} } != 0;
53 # check for any method
54 foreach my $name( keys %{$pack} ) {
55 my $entry = \$pack->{$name};
56 return 1 if ref($entry) ne 'GLOB' || defined *{$entry}{CODE};
64 # taken from Sub::Identify
67 ref($coderef) or return;
69 my $cv = B::svref_2object($coderef);
70 $cv->isa('B::CV') or return;
73 $gv->isa('B::GV') or return;
75 return ($gv->STASH->NAME, $gv->NAME);
81 my $cv = B::svref_2object($coderef);
82 $cv->isa('B::CV') or return '';
85 $gv->isa('B::GV') or return '';
87 return $gv->STASH->NAME;
91 my($package, $name) = @_;
94 use warnings FATAL => 'uninitialized';
95 return *{$package . '::' . $name}{CODE};
98 sub generate_isa_predicate_for {
99 my($for_class, $name) = @_;
101 my $predicate = sub{ Scalar::Util::blessed($_[0]) && $_[0]->isa($for_class) };
104 Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
111 sub generate_can_predicate_for {
112 my($methods_ref, $name) = @_;
114 my @methods = @{$methods_ref};
118 if(Scalar::Util::blessed($instance)){
119 foreach my $method(@methods){
120 if(!$instance->can($method)){
130 Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
137 package Mouse::Util::TypeConstraints;
139 use Scalar::Util qw(blessed looks_like_number openhandle);
144 sub Bool { $_[0] ? $_[0] eq '1' : 1 }
145 sub Undef { !defined($_[0]) }
146 sub Defined { defined($_[0]) }
147 sub Value { defined($_[0]) && !ref($_[0]) }
148 sub Num { looks_like_number($_[0]) }
151 looks_like_number($value) && $value =~ /\A [+-]? [0-9]+ \z/xms;
155 return defined($value) && ref(\$value) eq 'SCALAR';
158 sub Ref { ref($_[0]) }
161 return ref($value) eq 'SCALAR'
163 sub ArrayRef { ref($_[0]) eq 'ARRAY' }
164 sub HashRef { ref($_[0]) eq 'HASH' }
165 sub CodeRef { ref($_[0]) eq 'CODE' }
166 sub RegexpRef { ref($_[0]) eq 'Regexp' }
167 sub GlobRef { ref($_[0]) eq 'GLOB' }
170 return openhandle($_[0]) || (blessed($_[0]) && $_[0]->isa("IO::Handle"))
173 sub Object { blessed($_[0]) && blessed($_[0]) ne 'Regexp' }
175 sub ClassName { Mouse::Util::is_class_loaded($_[0]) }
176 sub RoleName { (Mouse::Util::class_of($_[0]) || return 0)->isa('Mouse::Meta::Role') }
178 sub _parameterize_ArrayRef_for {
179 my($type_parameter) = @_;
180 my $check = $type_parameter->_compiled_type_constraint;
183 foreach my $value (@{$_}) {
184 return undef unless $check->($value);
190 sub _parameterize_HashRef_for {
191 my($type_parameter) = @_;
192 my $check = $type_parameter->_compiled_type_constraint;
195 foreach my $value(values %{$_}){
196 return undef unless $check->($value);
202 # 'Maybe' type accepts 'Any', so it requires parameters
203 sub _parameterize_Maybe_for {
204 my($type_parameter) = @_;
205 my $check = $type_parameter->_compiled_type_constraint;
208 return !defined($_) || $check->($_);
212 package Mouse::Meta::Module;
214 sub name { $_[0]->{package} }
216 sub _method_map { $_[0]->{methods} }
217 sub _attribute_map{ $_[0]->{attributes} }
220 my $name = $_[0]->{package};
222 return \%{ $name . '::' };
226 my($self, $name, $code) = @_;
229 $self->throw_error('You must pass a defined name');
232 $self->throw_error('You must pass a defined code');
235 if(ref($code) ne 'CODE'){
236 $code = \&{$code}; # coerce
239 $self->{methods}->{$name} = $code; # Moose stores meta object here.
241 Mouse::Util::install_subroutines($self->name,
247 package Mouse::Meta::Class;
249 use Mouse::Meta::Method::Constructor;
250 use Mouse::Meta::Method::Destructor;
252 sub method_metaclass { $_[0]->{method_metaclass} || 'Mouse::Meta::Method' }
253 sub attribute_metaclass { $_[0]->{attribute_metaclass} || 'Mouse::Meta::Attribute' }
255 sub constructor_class { $_[0]->{constructor_class} || 'Mouse::Meta::Method::Constructor' }
256 sub destructor_class { $_[0]->{destructor_class} || 'Mouse::Meta::Method::Destructor' }
259 return exists $_[0]->{anon_serial_id};
262 sub roles { $_[0]->{roles} }
264 sub linearized_isa { @{ get_linear_isa($_[0]->{package}) } }
266 sub get_all_attributes {
268 my %attrs = map { %{ $self->initialize($_)->{attributes} } } reverse $self->linearized_isa;
269 return values %attrs;
274 my %args = (@_ == 1 ? %{$_[0]} : @_);
276 my $object = bless {}, $meta->name;
278 $meta->_initialize_object($object, \%args);
280 if( $object->can('BUILD') ) {
281 for my $class (reverse $meta->linearized_isa) {
282 my $build = Mouse::Util::get_code_ref($class, 'BUILD')
285 $object->$build(\%args);
294 my $args = $object->Mouse::Object::BUILDARGS(@_);
296 (blessed($object) && $object->isa($class->name))
297 || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
299 my $cloned = bless { %$object }, ref $object;
300 $class->_initialize_object($cloned, $args, 1);
305 sub _initialize_object{
306 my($self, $object, $args, $is_cloning) = @_;
310 foreach my $attribute ($self->get_all_attributes) {
311 my $init_arg = $attribute->init_arg;
312 my $slot = $attribute->name;
314 if (defined($init_arg) && exists($args->{$init_arg})) {
315 $object->{$slot} = $attribute->_coerce_and_verify($args->{$init_arg}, $object);
317 weaken($object->{$slot})
318 if ref($object->{$slot}) && $attribute->is_weak_ref;
320 if ($attribute->has_trigger) {
321 push @triggers_queue, [ $attribute->trigger, $object->{$slot} ];
325 if ($attribute->has_default || $attribute->has_builder) {
326 if (!$attribute->is_lazy && !exists $object->{$slot}) {
327 my $default = $attribute->default;
328 my $builder = $attribute->builder;
329 my $value = $builder ? $object->$builder()
330 : ref($default) eq 'CODE' ? $object->$default()
333 $object->{$slot} = $attribute->_coerce_and_verify($value, $object);
335 weaken($object->{$slot})
336 if ref($object->{$slot}) && $attribute->is_weak_ref;
339 elsif(!$is_cloning && $attribute->is_required) {
340 $self->throw_error("Attribute (".$attribute->name.") is required");
346 foreach my $trigger_and_value(@triggers_queue){
347 my($trigger, $value) = @{$trigger_and_value};
348 $trigger->($object, $value);
352 if($self->is_anon_class){
353 $object->{__METACLASS__} = $self;
359 sub is_immutable { $_[0]->{is_immutable} }
361 sub __strict_constructor{ $_[0]->{strict_constructor} }
363 package Mouse::Meta::Role;
365 sub method_metaclass{ $_[0]->{method_metaclass} || 'Mouse::Meta::Role::Method' }
368 return exists $_[0]->{anon_serial_id};
371 sub get_roles { $_[0]->{roles} }
373 sub add_before_method_modifier {
374 my ($self, $method_name, $method) = @_;
376 push @{ $self->{before_method_modifiers}{$method_name} ||= [] }, $method;
379 sub add_around_method_modifier {
380 my ($self, $method_name, $method) = @_;
382 push @{ $self->{around_method_modifiers}{$method_name} ||= [] }, $method;
385 sub add_after_method_modifier {
386 my ($self, $method_name, $method) = @_;
388 push @{ $self->{after_method_modifiers}{$method_name} ||= [] }, $method;
392 sub get_before_method_modifiers {
393 my ($self, $method_name) = @_;
394 return @{ $self->{before_method_modifiers}{$method_name} ||= [] }
396 sub get_around_method_modifiers {
397 my ($self, $method_name) = @_;
398 return @{ $self->{around_method_modifiers}{$method_name} ||= [] }
400 sub get_after_method_modifiers {
401 my ($self, $method_name) = @_;
402 return @{ $self->{after_method_modifiers}{$method_name} ||= [] }
405 package Mouse::Meta::Attribute;
407 require Mouse::Meta::Method::Accessor;
409 sub accessor_metaclass{ $_[0]->{accessor_metaclass} || 'Mouse::Meta::Method::Accessor' }
413 sub name { $_[0]->{name} }
414 sub associated_class { $_[0]->{associated_class} }
416 sub accessor { $_[0]->{accessor} }
417 sub reader { $_[0]->{reader} }
418 sub writer { $_[0]->{writer} }
419 sub predicate { $_[0]->{predicate} }
420 sub clearer { $_[0]->{clearer} }
421 sub handles { $_[0]->{handles} }
423 sub _is_metadata { $_[0]->{is} }
424 sub is_required { $_[0]->{required} }
425 sub default { $_[0]->{default} }
426 sub is_lazy { $_[0]->{lazy} }
427 sub is_lazy_build { $_[0]->{lazy_build} }
428 sub is_weak_ref { $_[0]->{weak_ref} }
429 sub init_arg { $_[0]->{init_arg} }
430 sub type_constraint { $_[0]->{type_constraint} }
432 sub trigger { $_[0]->{trigger} }
433 sub builder { $_[0]->{builder} }
434 sub should_auto_deref { $_[0]->{auto_deref} }
435 sub should_coerce { $_[0]->{coerce} }
437 sub documentation { $_[0]->{documentation} }
441 sub has_accessor { exists $_[0]->{accessor} }
442 sub has_reader { exists $_[0]->{reader} }
443 sub has_writer { exists $_[0]->{writer} }
444 sub has_predicate { exists $_[0]->{predicate} }
445 sub has_clearer { exists $_[0]->{clearer} }
446 sub has_handles { exists $_[0]->{handles} }
448 sub has_default { exists $_[0]->{default} }
449 sub has_type_constraint { exists $_[0]->{type_constraint} }
450 sub has_trigger { exists $_[0]->{trigger} }
451 sub has_builder { exists $_[0]->{builder} }
453 sub has_documentation { exists $_[0]->{documentation} }
455 sub _process_options{
456 my($class, $name, $args) = @_;
458 # taken from Class::MOP::Attribute::new
461 or $class->throw_error('You must provide a name for the attribute');
463 if(!exists $args->{init_arg}){
464 $args->{init_arg} = $name;
467 # 'required' requires eigher 'init_arg', 'builder', or 'default'
468 my $can_be_required = defined( $args->{init_arg} );
470 if(exists $args->{builder}){
472 # Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility
473 # This feature will be changed in a future. (gfx)
474 $class->throw_error('builder must be a defined scalar value which is a method name')
475 #if ref $args->{builder} || !defined $args->{builder};
476 if !defined $args->{builder};
480 elsif(exists $args->{default}){
481 if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
482 $class->throw_error("References are not allowed as default values, you must "
483 . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
488 if( $args->{required} && !$can_be_required ) {
489 $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
492 # taken from Mouse::Meta::Attribute->new and ->_process_args
494 if(exists $args->{is}){
495 my $is = $args->{is};
498 $args->{reader} ||= $name;
501 if(exists $args->{writer}){
502 $args->{reader} ||= $name;
505 $args->{accessor} ||= $name;
508 elsif($is eq 'bare'){
509 # do nothing, but don't complain (later) about missing methods
512 $is = 'undef' if !defined $is;
513 $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
518 if(exists $args->{isa}){
519 $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
522 if(exists $args->{does}){
523 if(defined $tc){ # both isa and does supplied
526 eval{ "$tc"->does($args) };
529 $class->throw_error("Cannot have both an isa option and a does option because '$tc' does not do '$args->{does}' on attribute ($name)");
533 $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
539 || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
542 && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
545 if ($args->{lazy_build}) {
546 exists($args->{default})
547 && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
550 $args->{builder} ||= "_build_${name}";
552 $args->{clearer} ||= "_clear${name}";
553 $args->{predicate} ||= "_has${name}";
556 $args->{clearer} ||= "clear_${name}";
557 $args->{predicate} ||= "has_${name}";
561 if ($args->{auto_deref}) {
563 || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
565 ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') )
566 || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
569 if (exists $args->{trigger}) {
570 ('CODE' eq ref $args->{trigger})
571 || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
575 (exists $args->{default} || defined $args->{builder})
576 || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
583 package Mouse::Meta::TypeConstraint;
585 sub name { $_[0]->{name} }
586 sub parent { $_[0]->{parent} }
587 sub message { $_[0]->{message} }
589 sub type_parameter { $_[0]->{type_parameter} }
590 sub _compiled_type_constraint{ $_[0]->{compiled_type_constraint} }
591 sub _compiled_type_coercion { $_[0]->{_compiled_type_coercion} }
593 sub __is_parameterized { exists $_[0]->{type_parameter} }
594 sub has_coercion { exists $_[0]->{_compiled_type_coercion} }
597 sub compile_type_constraint{
602 for(my $parent = $self->{parent}; defined $parent; $parent = $parent->{parent}){
603 if($parent->{hand_optimized_type_constraint}){
604 unshift @checks, $parent->{hand_optimized_type_constraint};
605 last; # a hand optimized constraint must include all the parents
607 elsif($parent->{constraint}){
608 unshift @checks, $parent->{constraint};
613 if($self->{constraint}){
614 push @checks, $self->{constraint};
617 if($self->{type_constraints}){ # Union
618 my @types = map{ $_->{compiled_type_constraint} } @{ $self->{type_constraints} };
620 foreach my $c(@types){
621 return 1 if $c->($_[0]);
628 $self->{compiled_type_constraint} = \&Mouse::Util::TypeConstraints::Any;
631 $self->{compiled_type_constraint} = sub{
634 foreach my $c(@checks){
635 return undef if !$c->(@args);
645 return $self->_compiled_type_constraint->(@_);
649 package Mouse::Object;
654 if (scalar @_ == 1) {
655 (ref($_[0]) eq 'HASH')
656 || $class->meta->throw_error("Single parameters to new() must be a HASH ref");
668 $class->meta->throw_error('Cannot call new() on an instance') if ref $class;
670 my $args = $class->BUILDARGS(@_);
672 my $meta = Mouse::Meta::Class->initialize($class);
673 return $meta->new_object($args);
679 return unless $self->can('DEMOLISH'); # short circuit
688 # We cannot count on being able to retrieve a previously made
689 # metaclass, _or_ being able to make a new one during global
690 # destruction. However, we should still be able to use mro at
691 # that time (at least tests suggest so ;)
693 foreach my $class (@{ Mouse::Util::get_linear_isa(ref $self) }) {
694 my $demolish = Mouse::Util::get_code_ref($class, 'DEMOLISH')
697 $self->$demolish($Mouse::Util::in_global_destruction);
704 die $e if $e; # rethrow
711 return unless $self->can('BUILD');
713 for my $class (reverse $self->meta->linearized_isa) {
714 my $build = Mouse::Util::get_code_ref($class, 'BUILD')
723 *DEMOLISHALL = \&DESTROY;
730 Mouse::PurePerl - A Mouse guts in pure Perl
734 This document describes Mouse version 0.60