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