Make clone_object() into PurePerl
[gitmo/Mouse.git] / lib / Mouse / PurePerl.pm
1 package Mouse::PurePerl;
2
3 require Mouse::Util;
4
5 package Mouse::Util;
6
7 use strict;
8 use warnings;
9
10 use warnings FATAL => 'redefine'; # to avoid to load Mouse::PurePerl
11
12 use B ();
13
14
15 # taken from Class/MOP.pm
16 sub is_valid_class_name {
17     my $class = shift;
18
19     return 0 if ref($class);
20     return 0 unless defined($class);
21
22     return 1 if $class =~ /\A \w+ (?: :: \w+ )* \z/xms;
23
24     return 0;
25 }
26
27 sub is_class_loaded {
28     my $class = shift;
29
30     return 0 if ref($class) || !defined($class) || !length($class);
31
32     # walk the symbol table tree to avoid autovififying
33     # \*{${main::}{"Foo::"}{"Bar::"}} == \*main::Foo::Bar::
34
35     my $pack = \%::;
36     foreach my $part (split('::', $class)) {
37         $part .= '::';
38         return 0 if !exists $pack->{$part};
39
40         my $entry = \$pack->{$part};
41         return 0 if ref($entry) ne 'GLOB';
42         $pack = *{$entry}{HASH};
43     }
44
45     return 0 if !%{$pack};
46
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;
52
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};
57     }
58
59     # fail
60     return 0;
61 }
62
63
64 # taken from Sub::Identify
65 sub get_code_info {
66     my ($coderef) = @_;
67     ref($coderef) or return;
68
69     my $cv = B::svref_2object($coderef);
70     $cv->isa('B::CV') or return;
71
72     my $gv = $cv->GV;
73     $gv->isa('B::GV') or return;
74
75     return ($gv->STASH->NAME, $gv->NAME);
76 }
77
78 sub get_code_package{
79     my($coderef) = @_;
80
81     my $cv = B::svref_2object($coderef);
82     $cv->isa('B::CV') or return '';
83
84     my $gv = $cv->GV;
85     $gv->isa('B::GV') or return '';
86
87     return $gv->STASH->NAME;
88 }
89
90 sub get_code_ref{
91     my($package, $name) = @_;
92     no strict 'refs';
93     no warnings 'once';
94     use warnings FATAL => 'uninitialized';
95     return *{$package . '::' . $name}{CODE};
96 }
97
98 sub generate_isa_predicate_for {
99     my($for_class, $name) = @_;
100
101     my $predicate = sub{ Scalar::Util::blessed($_[0]) && $_[0]->isa($for_class) };
102
103     if(defined $name){
104         Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
105         return;
106     }
107
108     return $predicate;
109 }
110
111 sub generate_can_predicate_for {
112     my($methods_ref, $name) = @_;
113
114     my @methods = @{$methods_ref};
115
116     my $predicate = sub{
117         my($instance) = @_;
118         if(Scalar::Util::blessed($instance)){
119             foreach my $method(@methods){
120                 if(!$instance->can($method)){
121                     return 0;
122                 }
123             }
124             return 1;
125         }
126         return 0;
127     };
128
129     if(defined $name){
130         Mouse::Util::install_subroutines(scalar caller, $name => $predicate);
131         return;
132     }
133
134     return $predicate;
135 }
136
137 package Mouse::Util::TypeConstraints;
138
139 use Scalar::Util qw(blessed looks_like_number openhandle);
140
141 sub Any        { 1 }
142 sub Item       { 1 }
143
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]) }
149 sub Int        {
150     my($value) = @_;
151     looks_like_number($value) && $value =~ /\A [+-]? [0-9]+  \z/xms;
152 }
153 sub Str        {
154     my($value) = @_;
155     return defined($value) && ref(\$value) eq 'SCALAR';
156 }
157
158 sub Ref        { ref($_[0]) }
159 sub ScalarRef  {
160     my($value) = @_;
161     return ref($value) eq 'SCALAR'
162 }
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'   }
168
169 sub FileHandle {
170     return openhandle($_[0])  || (blessed($_[0]) && $_[0]->isa("IO::Handle"))
171 }
172
173 sub Object     { blessed($_[0]) && blessed($_[0]) ne 'Regexp' }
174
175 sub ClassName  { Mouse::Util::is_class_loaded($_[0]) }
176 sub RoleName   { (Mouse::Util::class_of($_[0]) || return 0)->isa('Mouse::Meta::Role') }
177
178 sub _parameterize_ArrayRef_for {
179     my($type_parameter) = @_;
180     my $check = $type_parameter->_compiled_type_constraint;
181
182     return sub {
183         foreach my $value (@{$_}) {
184             return undef unless $check->($value);
185         }
186         return 1;
187     }
188 }
189
190 sub _parameterize_HashRef_for {
191     my($type_parameter) = @_;
192     my $check = $type_parameter->_compiled_type_constraint;
193
194     return sub {
195         foreach my $value(values %{$_}){
196             return undef unless $check->($value);
197         }
198         return 1;
199     };
200 }
201
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;
206
207     return sub{
208         return !defined($_) || $check->($_);
209     };
210 }
211
212 package Mouse::Meta::Module;
213
214 sub name          { $_[0]->{package} }
215
216 sub _method_map   { $_[0]->{methods} }
217 sub _attribute_map{ $_[0]->{attributes} }
218
219 sub namespace{
220     my $name = $_[0]->{package};
221     no strict 'refs';
222     return \%{ $name . '::' };
223 }
224
225 sub add_method {
226     my($self, $name, $code) = @_;
227
228     if(!defined $name){
229         $self->throw_error('You must pass a defined name');
230     }
231     if(!defined $code){
232         $self->throw_error('You must pass a defined code');
233     }
234
235     if(ref($code) ne 'CODE'){
236         $code = \&{$code}; # coerce
237     }
238
239     $self->{methods}->{$name} = $code; # Moose stores meta object here.
240
241     Mouse::Util::install_subroutines($self->name,
242         $name => $code,
243     );
244     return;
245 }
246
247 package Mouse::Meta::Class;
248
249 use Mouse::Meta::Method::Constructor;
250 use Mouse::Meta::Method::Destructor;
251
252 sub method_metaclass    { $_[0]->{method_metaclass}    || 'Mouse::Meta::Method'    }
253 sub attribute_metaclass { $_[0]->{attribute_metaclass} || 'Mouse::Meta::Attribute' }
254
255 sub constructor_class { $_[0]->{constructor_class} || 'Mouse::Meta::Method::Constructor' }
256 sub destructor_class  { $_[0]->{destructor_class}  || 'Mouse::Meta::Method::Destructor'  }
257
258 sub is_anon_class{
259     return exists $_[0]->{anon_serial_id};
260 }
261
262 sub roles { $_[0]->{roles} }
263
264 sub linearized_isa { @{ get_linear_isa($_[0]->{package}) } }
265
266 sub get_all_attributes {
267     my($self) = @_;
268     my %attrs = map { %{ $self->initialize($_)->{attributes} } } reverse $self->linearized_isa;
269     return values %attrs;
270 }
271
272 sub new_object {
273     my $meta = shift;
274     my %args = (@_ == 1 ? %{$_[0]} : @_);
275
276     my $object = bless {}, $meta->name;
277
278     $meta->_initialize_object($object, \%args);
279     # BUILDALL
280     if( $object->can('BUILD') ) {
281         for my $class (reverse $meta->linearized_isa) {
282             my $build = Mouse::Util::get_code_ref($class, 'BUILD')
283                 || next;
284
285             $object->$build(\%args);
286         }
287     }
288     return $object;
289 }
290
291 sub clone_object {
292     my $class  = shift;
293     my $object = shift;
294     my $args   = $object->Mouse::Object::BUILDARGS(@_);
295
296     (blessed($object) && $object->isa($class->name))
297         || $class->throw_error("You must pass an instance of the metaclass (" . $class->name . "), not ($object)");
298
299     my $cloned = bless { %$object }, ref $object;
300     $class->_initialize_object($cloned, $args, 1);
301
302     return $cloned;
303 }
304
305 sub _initialize_object{
306     my($self, $object, $args, $is_cloning) = @_;
307
308     my @triggers_queue;
309
310     foreach my $attribute ($self->get_all_attributes) {
311         my $init_arg = $attribute->init_arg;
312         my $slot     = $attribute->name;
313
314         if (defined($init_arg) && exists($args->{$init_arg})) {
315             $object->{$slot} = $attribute->_coerce_and_verify($args->{$init_arg}, $object);
316
317             weaken($object->{$slot})
318                 if ref($object->{$slot}) && $attribute->is_weak_ref;
319
320             if ($attribute->has_trigger) {
321                 push @triggers_queue, [ $attribute->trigger, $object->{$slot} ];
322             }
323         }
324         else { # no init arg
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()
331                                 :                           $default;
332
333                     $object->{$slot} = $attribute->_coerce_and_verify($value, $object);
334
335                     weaken($object->{$slot})
336                         if ref($object->{$slot}) && $attribute->is_weak_ref;
337                 }
338             }
339             elsif(!$is_cloning && $attribute->is_required) {
340                 $self->throw_error("Attribute (".$attribute->name.") is required");
341             }
342         }
343     }
344
345     if(@triggers_queue){
346         foreach my $trigger_and_value(@triggers_queue){
347             my($trigger, $value) = @{$trigger_and_value};
348             $trigger->($object, $value);
349         }
350     }
351
352     if($self->is_anon_class){
353         $object->{__METACLASS__} = $self;
354     }
355
356     return;
357 }
358
359 sub is_immutable {  $_[0]->{is_immutable} }
360
361 sub __strict_constructor{ $_[0]->{strict_constructor} }
362
363 package Mouse::Meta::Role;
364
365 sub method_metaclass{ $_[0]->{method_metaclass} || 'Mouse::Meta::Role::Method' }
366
367 sub is_anon_role{
368     return exists $_[0]->{anon_serial_id};
369 }
370
371 sub get_roles { $_[0]->{roles} }
372
373 sub add_before_method_modifier {
374     my ($self, $method_name, $method) = @_;
375
376     push @{ $self->{before_method_modifiers}{$method_name} ||= [] }, $method;
377     return;
378 }
379 sub add_around_method_modifier {
380     my ($self, $method_name, $method) = @_;
381
382     push @{ $self->{around_method_modifiers}{$method_name} ||= [] }, $method;
383     return;
384 }
385 sub add_after_method_modifier {
386     my ($self, $method_name, $method) = @_;
387
388     push @{ $self->{after_method_modifiers}{$method_name} ||= [] }, $method;
389     return;
390 }
391
392 sub get_before_method_modifiers {
393     my ($self, $method_name) = @_;
394     return @{ $self->{before_method_modifiers}{$method_name} ||= [] }
395 }
396 sub get_around_method_modifiers {
397     my ($self, $method_name) = @_;
398     return @{ $self->{around_method_modifiers}{$method_name} ||= [] }
399 }
400 sub get_after_method_modifiers {
401     my ($self, $method_name) = @_;
402     return @{ $self->{after_method_modifiers}{$method_name} ||= [] }
403 }
404
405 package Mouse::Meta::Attribute;
406
407 require Mouse::Meta::Method::Accessor;
408
409 sub accessor_metaclass{ $_[0]->{accessor_metaclass} || 'Mouse::Meta::Method::Accessor' }
410
411 # readers
412
413 sub name                 { $_[0]->{name}                   }
414 sub associated_class     { $_[0]->{associated_class}       }
415
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}                }
422
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}        }
431
432 sub trigger              { $_[0]->{trigger}                }
433 sub builder              { $_[0]->{builder}                }
434 sub should_auto_deref    { $_[0]->{auto_deref}             }
435 sub should_coerce        { $_[0]->{coerce}                 }
436
437 sub documentation        { $_[0]->{documentation}          }
438
439 # predicates
440
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}         }
447
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}         }
452
453 sub has_documentation    { exists $_[0]->{documentation}   }
454
455 sub _process_options{
456     my($class, $name, $args) = @_;
457
458     # taken from Class::MOP::Attribute::new
459
460     defined($name)
461         or $class->throw_error('You must provide a name for the attribute');
462
463     if(!exists $args->{init_arg}){
464         $args->{init_arg} = $name;
465     }
466
467     # 'required' requires eigher 'init_arg', 'builder', or 'default'
468     my $can_be_required = defined( $args->{init_arg} );
469
470     if(exists $args->{builder}){
471         # XXX:
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};
477
478         $can_be_required++;
479     }
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 [])");
484         }
485         $can_be_required++;
486     }
487
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");
490     }
491
492     # taken from Mouse::Meta::Attribute->new and ->_process_args
493
494     if(exists $args->{is}){
495         my $is = $args->{is};
496
497         if($is eq 'ro'){
498             $args->{reader} ||= $name;
499         }
500         elsif($is eq 'rw'){
501             if(exists $args->{writer}){
502                 $args->{reader} ||= $name;
503              }
504              else{
505                 $args->{accessor} ||= $name;
506              }
507         }
508         elsif($is eq 'bare'){
509             # do nothing, but don't complain (later) about missing methods
510         }
511         else{
512             $is = 'undef' if !defined $is;
513             $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
514         }
515     }
516
517     my $tc;
518     if(exists $args->{isa}){
519         $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
520     }
521
522     if(exists $args->{does}){
523         if(defined $tc){ # both isa and does supplied
524             my $does_ok = do{
525                 local $@;
526                 eval{ "$tc"->does($args) };
527             };
528             if(!$does_ok){
529                 $class->throw_error("Cannot have both an isa option and a does option because '$tc' does not do '$args->{does}' on attribute ($name)");
530             }
531         }
532         else {
533             $tc = $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
534         }
535     }
536
537     if($args->{coerce}){
538         defined($tc)
539             || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
540
541         $args->{weak_ref}
542             && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
543     }
544
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)");
548
549         $args->{lazy}      = 1;
550         $args->{builder} ||= "_build_${name}";
551         if ($name =~ /^_/) {
552             $args->{clearer}   ||= "_clear${name}";
553             $args->{predicate} ||= "_has${name}";
554         }
555         else {
556             $args->{clearer}   ||= "clear_${name}";
557             $args->{predicate} ||= "has_${name}";
558         }
559     }
560
561     if ($args->{auto_deref}) {
562         defined($tc)
563             || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
564
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)");
567     }
568
569     if (exists $args->{trigger}) {
570         ('CODE' eq ref $args->{trigger})
571             || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
572     }
573
574     if ($args->{lazy}) {
575         (exists $args->{default} || defined $args->{builder})
576             || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
577     }
578
579     return;
580 }
581
582
583 package Mouse::Meta::TypeConstraint;
584
585 sub name    { $_[0]->{name}    }
586 sub parent  { $_[0]->{parent}  }
587 sub message { $_[0]->{message} }
588
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}  }
592
593 sub __is_parameterized { exists $_[0]->{type_parameter} }
594 sub has_coercion {       exists $_[0]->{_compiled_type_coercion} }
595
596
597 sub compile_type_constraint{
598     my($self) = @_;
599
600     # add parents first
601     my @checks;
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
606         }
607         elsif($parent->{constraint}){
608             unshift @checks, $parent->{constraint};
609         }
610     }
611
612     # then add child
613     if($self->{constraint}){
614         push @checks, $self->{constraint};
615     }
616
617     if($self->{type_constraints}){ # Union
618         my @types = map{ $_->{compiled_type_constraint} } @{ $self->{type_constraints} };
619         push @checks, sub{
620             foreach my $c(@types){
621                 return 1 if $c->($_[0]);
622             }
623             return 0;
624         };
625     }
626
627     if(@checks == 0){
628         $self->{compiled_type_constraint} = \&Mouse::Util::TypeConstraints::Any;
629     }
630     else{
631         $self->{compiled_type_constraint} =  sub{
632             my(@args) = @_;
633             local $_ = $args[0];
634             foreach my $c(@checks){
635                 return undef if !$c->(@args);
636             }
637             return 1;
638         };
639     }
640     return;
641 }
642
643 sub check {
644     my $self = shift;
645     return $self->_compiled_type_constraint->(@_);
646 }
647
648
649 package Mouse::Object;
650
651 sub BUILDARGS {
652     my $class = shift;
653
654     if (scalar @_ == 1) {
655         (ref($_[0]) eq 'HASH')
656             || $class->meta->throw_error("Single parameters to new() must be a HASH ref");
657
658         return {%{$_[0]}};
659     }
660     else {
661         return {@_};
662     }
663 }
664
665 sub new {
666     my $class = shift;
667
668     $class->meta->throw_error('Cannot call new() on an instance') if ref $class;
669
670     my $args = $class->BUILDARGS(@_);
671
672     my $meta = Mouse::Meta::Class->initialize($class);
673     return $meta->new_object($args);
674 }
675
676 sub DESTROY {
677     my $self = shift;
678
679     return unless $self->can('DEMOLISH'); # short circuit
680
681     local $?;
682
683     my $e = do{
684         local $@;
685         eval{
686             # DEMOLISHALL
687
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 ;)
692
693             foreach my $class (@{ Mouse::Util::get_linear_isa(ref $self) }) {
694                 my $demolish = Mouse::Util::get_code_ref($class, 'DEMOLISH')
695                     || next;
696
697                 $self->$demolish($Mouse::Util::in_global_destruction);
698             }
699         };
700         $@;
701     };
702
703     no warnings 'misc';
704     die $e if $e; # rethrow
705 }
706
707 sub BUILDALL {
708     my $self = shift;
709
710     # short circuit
711     return unless $self->can('BUILD');
712
713     for my $class (reverse $self->meta->linearized_isa) {
714         my $build = Mouse::Util::get_code_ref($class, 'BUILD')
715             || next;
716
717         $self->$build(@_);
718     }
719     return;
720 }
721
722 sub DEMOLISHALL;
723 *DEMOLISHALL = \&DESTROY;
724
725 1;
726 __END__
727
728 =head1 NAME
729
730 Mouse::PurePerl - A Mouse guts in pure Perl
731
732 =head1 VERSION
733
734 This document describes Mouse version 0.59
735
736 =head1 SEE ALSO
737
738 L<Mouse::XS>
739
740 =cut