improve alias/excludes warning
[gitmo/Moose.git] / lib / Moose / Meta / Role.pm
CommitLineData
e185c027 1
2package Moose::Meta::Role;
3
4use strict;
5use warnings;
6use metaclass;
7
21f1e231 8use Scalar::Util 'blessed';
b6a00b82 9use Carp 'confess';
963c24e1 10use Devel::GlobalDestruction 'in_global_destruction';
bdabd620 11
f4b86ac0 12our $VERSION = '1.16';
e606ae5f 13$VERSION = eval $VERSION;
d44714be 14our $AUTHORITY = 'cpan:STEVAN';
e185c027 15
8ee73eeb 16use Moose::Meta::Class;
f785aad8 17use Moose::Meta::Role::Attribute;
39b3bc94 18use Moose::Meta::Role::Method;
d67145ed 19use Moose::Meta::Role::Method::Required;
bb153262 20use Moose::Meta::Role::Method::Conflicting;
699a2e32 21use Moose::Meta::Method::Meta;
f785aad8 22use Moose::Util qw( ensure_all_roles );
d2782813 23use Class::MOP::MiniTrait;
8ee73eeb 24
72276e04 25use base 'Class::MOP::Module',
26 'Class::MOP::Mixin::HasAttributes',
27 'Class::MOP::Mixin::HasMethods';
80572233 28
d2782813 29Class::MOP::MiniTrait::apply(__PACKAGE__, 'Moose::Meta::Object::Trait');
30
fb1e11d5 31## ------------------------------------------------------------------
32## NOTE:
33## I normally don't do this, but I am doing
34## a whole bunch of meta-programmin in this
35## module, so it just makes sense. For a clearer
d03bd989 36## picture of what is going on in the next
37## several lines of code, look at the really
fb1e11d5 38## big comment at the end of this file (right
39## before the POD).
40## - SL
41## ------------------------------------------------------------------
80572233 42
21716c07 43my $META = __PACKAGE__->meta;
44
45## ------------------------------------------------------------------
46## attributes ...
e185c027 47
21716c07 48# NOTE:
49# since roles are lazy, we hold all the attributes
fb1e11d5 50# of the individual role in 'statis' until which
51# time when it is applied to a class. This means
52# keeping a lot of things in hash maps, so we are
21716c07 53# using a little of that meta-programmin' magic
d03bd989 54# here an saving lots of extra typin. And since
fb1e11d5 55# many of these attributes above require similar
56# functionality to support them, so we again use
57# the wonders of meta-programmin' to deliver a
21716c07 58# very compact solution to this normally verbose
59# problem.
60# - SL
61
62foreach my $action (
fb1e11d5 63 {
64 name => 'excluded_roles_map',
65 attr_reader => 'get_excluded_roles_map' ,
21716c07 66 methods => {
fb1e11d5 67 add => 'add_excluded_roles',
55f28f0a 68 get_keys => 'get_excluded_roles_list',
fb1e11d5 69 existence => 'excludes_role',
21716c07 70 }
71 },
fb1e11d5 72 {
73 name => 'required_methods',
21716c07 74 attr_reader => 'get_required_methods_map',
75 methods => {
7c62cb0a 76 remove => 'remove_required_methods',
77 get_values => 'get_required_method_list',
78 existence => 'requires_method',
21716c07 79 }
d03bd989 80 },
21716c07 81) {
fb1e11d5 82
21716c07 83 my $attr_reader = $action->{attr_reader};
84 my $methods = $action->{methods};
fb1e11d5 85
86 # create the attribute
87 $META->add_attribute($action->{name} => (
88 reader => $attr_reader,
89 default => sub { {} }
90 ));
91
92 # create some helper methods
21716c07 93 $META->add_method($methods->{add} => sub {
94 my ($self, @values) = @_;
fb1e11d5 95 $self->$attr_reader->{$_} = undef foreach @values;
21716c07 96 }) if exists $methods->{add};
fb1e11d5 97
55f28f0a 98 $META->add_method($methods->{get_keys} => sub {
21716c07 99 my ($self) = @_;
fb1e11d5 100 keys %{$self->$attr_reader};
55f28f0a 101 }) if exists $methods->{get_keys};
fb1e11d5 102
8a0bfed9 103 $META->add_method($methods->{get_values} => sub {
104 my ($self) = @_;
105 values %{$self->$attr_reader};
106 }) if exists $methods->{get_values};
107
21716c07 108 $META->add_method($methods->{get} => sub {
109 my ($self, $name) = @_;
fb1e11d5 110 $self->$attr_reader->{$name}
111 }) if exists $methods->{get};
112
21716c07 113 $META->add_method($methods->{existence} => sub {
114 my ($self, $name) = @_;
fb1e11d5 115 exists $self->$attr_reader->{$name} ? 1 : 0;
116 }) if exists $methods->{existence};
117
21716c07 118 $META->add_method($methods->{remove} => sub {
119 my ($self, @values) = @_;
120 delete $self->$attr_reader->{$_} foreach @values;
fb1e11d5 121 }) if exists $methods->{remove};
21716c07 122}
d79e62fd 123
b05518b2 124$META->add_attribute(
125 'method_metaclass',
126 reader => 'method_metaclass',
127 default => 'Moose::Meta::Role::Method',
128);
129
77ed8b8d 130$META->add_attribute(
131 'required_method_metaclass',
132 reader => 'required_method_metaclass',
133 default => 'Moose::Meta::Role::Method::Required',
134);
135
eec8ca8a 136$META->add_attribute(
bb153262 137 'conflicting_method_metaclass',
138 reader => 'conflicting_method_metaclass',
139 default => 'Moose::Meta::Role::Method::Conflicting',
eec8ca8a 140);
141
07de7559 142$META->add_attribute(
143 'application_to_class_class',
144 reader => 'application_to_class_class',
145 default => 'Moose::Meta::Role::Application::ToClass',
146);
147
148$META->add_attribute(
149 'application_to_role_class',
150 reader => 'application_to_role_class',
151 default => 'Moose::Meta::Role::Application::ToRole',
152);
153
154$META->add_attribute(
155 'application_to_instance_class',
156 reader => 'application_to_instance_class',
157 default => 'Moose::Meta::Role::Application::ToInstance',
158);
159
f785aad8 160# More or less copied from Moose::Meta::Class
161sub initialize {
162 my $class = shift;
163 my $pkg = shift;
6f73c555 164
165 if (defined(my $meta = Class::MOP::get_metaclass_by_name($pkg))) {
166 return $meta;
167 }
168
169 my %options = @_;
170
171 my $meta = $class->SUPER::initialize(
f785aad8 172 $pkg,
173 'attribute_metaclass' => 'Moose::Meta::Role::Attribute',
6f73c555 174 %options,
175 );
176
177 Class::MOP::weaken_metaclass($pkg) if $options{weaken};
178
179 return $meta;
f785aad8 180}
80572233 181
f785aad8 182sub reinitialize {
21716c07 183 my $self = shift;
f785aad8 184 my $pkg = shift;
185
186 my $meta = blessed $pkg ? $pkg : Class::MOP::class_of($pkg);
187
188 my %existing_classes;
189 if ($meta) {
190 %existing_classes = map { $_ => $meta->$_() } qw(
191 attribute_metaclass
192 method_metaclass
193 wrapped_method_metaclass
194 required_method_metaclass
195 conflicting_method_metaclass
196 application_to_class_class
197 application_to_role_class
198 application_to_instance_class
199 );
70ea9161 200 }
f785aad8 201
6f73c555 202 my %options = @_;
203 $options{weaken} = Class::MOP::metaclass_is_weak($meta->name)
204 if !exists $options{weaken}
205 && blessed($meta)
206 && $meta->isa('Moose::Meta::Role');
207
6feff4da 208 # don't need to remove generated metaobjects here yet, since we don't
209 # yet generate anything in roles. this may change in the future though...
210 # keep an eye on that
211 my $new_meta = $self->SUPER::reinitialize(
f785aad8 212 $pkg,
213 %existing_classes,
6f73c555 214 %options,
f785aad8 215 );
6feff4da 216 $new_meta->_restore_metaobjects_from($meta)
217 if $meta && $meta->isa('Moose::Meta::Role');
218 return $new_meta;
219}
220
221sub _restore_metaobjects_from {
222 my $self = shift;
223 my ($old_meta) = @_;
224
225 $self->_restore_metamethods_from($old_meta);
226 $self->_restore_metaattributes_from($old_meta);
f785aad8 227}
228
229sub add_attribute {
230 my $self = shift;
231
232 if (blessed $_[0] && ! $_[0]->isa('Moose::Meta::Role::Attribute') ) {
233 my $class = ref $_[0];
234 Moose->throw_error( "Cannot add a $class as an attribute to a role" );
21716c07 235 }
8c063f8e 236 elsif (!blessed($_[0]) && defined($_[0]) && $_[0] =~ /^\+(.*)/) {
576cd474 237 Moose->throw_error( "has '+attr' is not supported in roles" );
238 }
f785aad8 239
240 return $self->SUPER::add_attribute(@_);
241}
242
243sub _attach_attribute {
244 my ( $self, $attribute ) = @_;
245
246 $attribute->attach_to_role($self);
21716c07 247}
e185c027 248
16d721b3 249sub add_required_methods {
250 my $self = shift;
251
252 for (@_) {
253 my $method = $_;
c9d7e396 254 if (!blessed($method)) {
16d721b3 255 $method = $self->required_method_metaclass->new(
256 name => $method,
257 );
258 }
259 $self->get_required_methods_map->{$method->name} = $method;
260 }
261}
262
bb153262 263sub add_conflicting_method {
09eeab06 264 my $self = shift;
265
266 my $method;
267 if (@_ == 1 && blessed($_[0])) {
268 $method = shift;
269 }
270 else {
bb153262 271 $method = $self->conflicting_method_metaclass->new(@_);
09eeab06 272 }
273
274 $self->add_required_methods($method);
275}
276
21716c07 277## ------------------------------------------------------------------
278## method modifiers
279
21716c07 280# NOTE:
fb1e11d5 281# the before/around/after method modifiers are
21716c07 282# stored by name, but there can be many methods
283# then associated with that name. So again we have
284# lots of similar functionality, so we can do some
285# meta-programmin' and save some time.
286# - SL
287
288foreach my $modifier_type (qw[ before around after ]) {
fb1e11d5 289
290 my $attr_reader = "get_${modifier_type}_method_modifiers_map";
d03bd989 291
fb1e11d5 292 # create the attribute ...
293 $META->add_attribute("${modifier_type}_method_modifiers" => (
294 reader => $attr_reader,
295 default => sub { {} }
d03bd989 296 ));
fb1e11d5 297
298 # and some helper methods ...
21716c07 299 $META->add_method("get_${modifier_type}_method_modifiers" => sub {
300 my ($self, $method_name) = @_;
fb1e11d5 301 #return () unless exists $self->$attr_reader->{$method_name};
d9847263 302 my $mm = $self->$attr_reader->{$method_name};
303 $mm ? @$mm : ();
21716c07 304 });
fb1e11d5 305
21716c07 306 $META->add_method("has_${modifier_type}_method_modifiers" => sub {
307 my ($self, $method_name) = @_;
308 # NOTE:
fb1e11d5 309 # for now we assume that if it exists,..
21716c07 310 # it has at least one modifier in it
311 (exists $self->$attr_reader->{$method_name}) ? 1 : 0;
fb1e11d5 312 });
313
21716c07 314 $META->add_method("add_${modifier_type}_method_modifier" => sub {
315 my ($self, $method_name, $method) = @_;
fb1e11d5 316
317 $self->$attr_reader->{$method_name} = []
21716c07 318 unless exists $self->$attr_reader->{$method_name};
fb1e11d5 319
21716c07 320 my $modifiers = $self->$attr_reader->{$method_name};
fb1e11d5 321
21716c07 322 # NOTE:
fb1e11d5 323 # check to see that we aren't adding the
324 # same code twice. We err in favor of the
21716c07 325 # first on here, this may not be as expected
326 foreach my $modifier (@{$modifiers}) {
327 return if $modifier == $method;
328 }
fb1e11d5 329
21716c07 330 push @{$modifiers} => $method;
331 });
fb1e11d5 332
21716c07 333}
1331430a 334
21716c07 335## ------------------------------------------------------------------
336## override method mofidiers
0558683c 337
fb1e11d5 338$META->add_attribute('override_method_modifiers' => (
339 reader => 'get_override_method_modifiers_map',
340 default => sub { {} }
341));
342
21716c07 343# NOTE:
fb1e11d5 344# these are a little different because there
21716c07 345# can only be one per name, whereas the other
346# method modifiers can have multiples.
347# - SL
0558683c 348
21716c07 349sub add_override_method_modifier {
350 my ($self, $method_name, $method) = @_;
351 (!$self->has_method($method_name))
c245d69b 352 || Moose->throw_error("Cannot add an override of method '$method_name' " .
4c0b3599 353 "because there is a local version of '$method_name'");
fb1e11d5 354 $self->get_override_method_modifiers_map->{$method_name} = $method;
21716c07 355}
0558683c 356
21716c07 357sub has_override_method_modifier {
358 my ($self, $method_name) = @_;
359 # NOTE:
fb1e11d5 360 # for now we assume that if it exists,..
21716c07 361 # it has at least one modifier in it
fb1e11d5 362 (exists $self->get_override_method_modifiers_map->{$method_name}) ? 1 : 0;
21716c07 363}
0558683c 364
21716c07 365sub get_override_method_modifier {
366 my ($self, $method_name) = @_;
fb1e11d5 367 $self->get_override_method_modifiers_map->{$method_name};
21716c07 368}
0558683c 369
21716c07 370## general list accessor ...
80572233 371
21716c07 372sub get_method_modifier_list {
373 my ($self, $modifier_type) = @_;
fb1e11d5 374 my $accessor = "get_${modifier_type}_method_modifiers_map";
21716c07 375 keys %{$self->$accessor};
376}
e185c027 377
e606ae5f 378sub reset_package_cache_flag { (shift)->{'_package_cache_flag'} = undef }
379sub update_package_cache_flag {
380 my $self = shift;
381 $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name);
382}
383
384
699a2e32 385sub _meta_method_class { 'Moose::Meta::Method::Meta' }
e606ae5f 386
21716c07 387## ------------------------------------------------------------------
80572233 388## subroles
389
278ca49c 390$META->add_attribute('roles' => (
21716c07 391 reader => 'get_roles',
392 default => sub { [] }
393));
394
80572233 395sub add_role {
396 my ($self, $role) = @_;
397 (blessed($role) && $role->isa('Moose::Meta::Role'))
c245d69b 398 || Moose->throw_error("Roles must be instances of Moose::Meta::Role");
80572233 399 push @{$self->get_roles} => $role;
e606ae5f 400 $self->reset_package_cache_flag;
80572233 401}
402
b8aeb4dc 403sub calculate_all_roles {
404 my $self = shift;
405 my %seen;
fb1e11d5 406 grep {
407 !$seen{$_->name}++
408 } ($self, map {
409 $_->calculate_all_roles
410 } @{ $self->get_roles });
b8aeb4dc 411}
412
80572233 413sub does_role {
560c498d 414 my ($self, $role) = @_;
415 (defined $role)
c245d69b 416 || Moose->throw_error("You must supply a role name to look for");
560c498d 417 my $role_name = blessed $role ? $role->name : $role;
bdabd620 418 # if we are it,.. then return true
419 return 1 if $role_name eq $self->name;
420 # otherwise.. check our children
80572233 421 foreach my $role (@{$self->get_roles}) {
bdabd620 422 return 1 if $role->does_role($role_name);
80572233 423 }
424 return 0;
425}
426
1db8ecc7 427sub find_method_by_name { (shift)->get_method(@_) }
093b12c2 428
21716c07 429## ------------------------------------------------------------------
fb1e11d5 430## role construction
21716c07 431## ------------------------------------------------------------------
e185c027 432
21716c07 433sub apply {
f315aab3 434 my ($self, $other, %args) = @_;
bca01282 435
436 (blessed($other))
c245d69b 437 || Moose->throw_error("You must pass in an blessed instance");
d03bd989 438
07de7559 439 my $application_class;
1c9db35c 440 if ($other->isa('Moose::Meta::Role')) {
07de7559 441 $application_class = $self->application_to_role_class;
1c9db35c 442 }
443 elsif ($other->isa('Moose::Meta::Class')) {
07de7559 444 $application_class = $self->application_to_class_class;
d03bd989 445 }
1c9db35c 446 else {
07de7559 447 $application_class = $self->application_to_instance_class;
d03bd989 448 }
07de7559 449
450 Class::MOP::load_class($application_class);
f315aab3 451 return $application_class->new(%args)->apply($self, $other, \%args);
0558683c 452}
453
4701ceff 454sub composition_class_roles { }
455
21716c07 456sub combine {
a4e516f6 457 my ($class, @role_specs) = @_;
d03bd989 458
d03bd989 459 require Moose::Meta::Role::Composite;
460
28412c0b 461 my (@roles, %role_params);
462 while (@role_specs) {
560c498d 463 my ($role, $params) = @{ splice @role_specs, 0, 1 };
464 my $requested_role
465 = blessed $role
466 ? $role
467 : Class::MOP::class_of($role);
31d96c3e 468
6bdef412 469 my $actual_role = $requested_role->_role_for_combination($params);
31d96c3e 470 push @roles => $actual_role;
471
28412c0b 472 next unless defined $params;
31d96c3e 473 $role_params{$actual_role->name} = $params;
28412c0b 474 }
d03bd989 475
fb1e11d5 476 my $c = Moose::Meta::Role::Composite->new(roles => \@roles);
7071e2cb 477 return $c->apply_params(\%role_params);
0558683c 478}
479
6bdef412 480sub _role_for_combination {
436d7a28 481 my ($self, $params) = @_;
482 return $self;
483}
484
b6a00b82 485sub create {
2d5f3fab 486 my ( $role, $package_name, %options ) = @_;
b6a00b82 487
2d5f3fab 488 $options{package} = $package_name;
b6a00b82 489
490 (ref $options{attributes} eq 'HASH')
491 || confess "You must pass a HASH ref of attributes"
492 if exists $options{attributes};
493
494 (ref $options{methods} eq 'HASH')
495 || confess "You must pass a HASH ref of methods"
496 if exists $options{methods};
497
2937ed18 498 $options{meta_name} = 'meta'
499 unless exists $options{meta_name};
500
2d5f3fab 501 my (%initialize_options) = %options;
b6a00b82 502 delete @initialize_options{qw(
503 package
504 attributes
505 methods
2937ed18 506 meta_name
b6a00b82 507 version
508 authority
509 )};
510
511 my $meta = $role->initialize( $package_name => %initialize_options );
512
6a4a7c31 513 $meta->_instantiate_module( $options{version}, $options{authority} );
514
2937ed18 515 $meta->_add_meta_method($options{meta_name})
516 if defined $options{meta_name};
b6a00b82 517
518 if (exists $options{attributes}) {
519 foreach my $attribute_name (keys %{$options{attributes}}) {
520 my $attr = $options{attributes}->{$attribute_name};
f785aad8 521 $meta->add_attribute(
522 $attribute_name => blessed $attr ? $attr : %{$attr} );
b6a00b82 523 }
524 }
525
526 if (exists $options{methods}) {
527 foreach my $method_name (keys %{$options{methods}}) {
528 $meta->add_method($method_name, $options{methods}->{$method_name});
529 }
530 }
531
532 return $meta;
533}
534
c23885b1 535sub consumers {
536 my $self = shift;
537 my @consumers;
538 for my $meta (Class::MOP::get_all_metaclass_instances) {
539 next if $meta->name eq $self->name;
540 next unless $meta->isa('Moose::Meta::Class')
541 || $meta->isa('Moose::Meta::Role');
542 push @consumers, $meta->name
543 if $meta->does_role($self->name);
544 }
545 return @consumers;
546}
547
c9ee520d 548# anonymous roles. most of it is copied straight out of Class::MOP::Class.
549# an intrepid hacker might find great riches if he unifies this code with that
550# code in Class::MOP::Module or Class::MOP::Package
551{
552 # NOTE:
553 # this should be sufficient, if you have a
554 # use case where it is not, write a test and
555 # I will change it.
556 my $ANON_ROLE_SERIAL = 0;
557
558 # NOTE:
559 # we need a sufficiently annoying prefix
560 # this should suffice for now, this is
561 # used in a couple of places below, so
562 # need to put it up here for now.
563 my $ANON_ROLE_PREFIX = 'Moose::Meta::Role::__ANON__::SERIAL::';
564
565 sub is_anon_role {
566 my $self = shift;
567 no warnings 'uninitialized';
568 $self->name =~ /^$ANON_ROLE_PREFIX/;
569 }
570
571 sub create_anon_role {
572 my ($role, %options) = @_;
6f73c555 573 $options{weaken} = 1 unless exists $options{weaken};
c9ee520d 574 my $package_name = $ANON_ROLE_PREFIX . ++$ANON_ROLE_SERIAL;
575 return $role->create($package_name, %options);
576 }
577
578 # NOTE:
579 # this will only get called for
580 # anon-roles, all other calls
581 # are assumed to occur during
582 # global destruction and so don't
583 # really need to be handled explicitly
584 sub DESTROY {
585 my $self = shift;
586
963c24e1 587 return if in_global_destruction(); # it'll happen soon anyway and this just makes things more complicated
c9ee520d 588
589 no warnings 'uninitialized';
590 return unless $self->name =~ /^$ANON_ROLE_PREFIX/;
591
592 # XXX: is this necessary for us? I don't understand what it's doing
593 # -sartak
594
595 # Moose does a weird thing where it replaces the metaclass for
596 # class when fixing metaclass incompatibility. In that case,
597 # we don't want to clean out the namespace now. We can detect
598 # that because Moose will explicitly update the singleton
599 # cache in Class::MOP.
600 #my $current_meta = Class::MOP::get_metaclass_by_name($self->name);
601 #return if $current_meta ne $self;
602
603 my ($serial_id) = ($self->name =~ /^$ANON_ROLE_PREFIX(\d+)/);
604 no strict 'refs';
605 foreach my $key (keys %{$ANON_ROLE_PREFIX . $serial_id}) {
606 delete ${$ANON_ROLE_PREFIX . $serial_id}{$key};
607 }
608 delete ${'main::' . $ANON_ROLE_PREFIX}{$serial_id . '::'};
609 }
610}
611
fb1e11d5 612#####################################################################
613## NOTE:
d03bd989 614## This is Moose::Meta::Role as defined by Moose (plus the use of
615## MooseX::AttributeHelpers module). It is here as a reference to
fb1e11d5 616## make it easier to see what is happening above with all the meta
617## programming. - SL
618#####################################################################
619#
620# has 'roles' => (
a40b446a 621# metaclass => 'Array',
fb1e11d5 622# reader => 'get_roles',
764a7831 623# isa => 'ArrayRef[Moose::Meta::Role]',
fb1e11d5 624# default => sub { [] },
625# provides => {
626# 'push' => 'add_role',
627# }
628# );
d03bd989 629#
fb1e11d5 630# has 'excluded_roles_map' => (
a40b446a 631# metaclass => 'Hash',
fb1e11d5 632# reader => 'get_excluded_roles_map',
633# isa => 'HashRef[Str]',
634# provides => {
635# # Not exactly set, cause it sets multiple
636# 'set' => 'add_excluded_roles',
637# 'keys' => 'get_excluded_roles_list',
638# 'exists' => 'excludes_role',
639# }
640# );
d03bd989 641#
fb1e11d5 642# has 'required_methods' => (
a40b446a 643# metaclass => 'Hash',
fb1e11d5 644# reader => 'get_required_methods_map',
72264f10 645# isa => 'HashRef[Moose::Meta::Role::Method::Required]',
d03bd989 646# provides => {
647# # not exactly set, or delete since it works for multiple
fb1e11d5 648# 'set' => 'add_required_methods',
649# 'delete' => 'remove_required_methods',
650# 'keys' => 'get_required_method_list',
d03bd989 651# 'exists' => 'requires_method',
fb1e11d5 652# }
653# );
d03bd989 654#
655# # the before, around and after modifiers are
656# # HASH keyed by method-name, with ARRAY of
fb1e11d5 657# # CODE refs to apply in that order
d03bd989 658#
fb1e11d5 659# has 'before_method_modifiers' => (
a40b446a 660# metaclass => 'Hash',
fb1e11d5 661# reader => 'get_before_method_modifiers_map',
662# isa => 'HashRef[ArrayRef[CodeRef]]',
663# provides => {
664# 'keys' => 'get_before_method_modifiers',
d03bd989 665# 'exists' => 'has_before_method_modifiers',
666# # This actually makes sure there is an
fb1e11d5 667# # ARRAY at the given key, and pushed onto
668# # it. It also checks for duplicates as well
d03bd989 669# # 'add' => 'add_before_method_modifier'
670# }
fb1e11d5 671# );
d03bd989 672#
fb1e11d5 673# has 'after_method_modifiers' => (
a40b446a 674# metaclass => 'Hash',
fb1e11d5 675# reader =>'get_after_method_modifiers_map',
676# isa => 'HashRef[ArrayRef[CodeRef]]',
677# provides => {
678# 'keys' => 'get_after_method_modifiers',
d03bd989 679# 'exists' => 'has_after_method_modifiers',
680# # This actually makes sure there is an
fb1e11d5 681# # ARRAY at the given key, and pushed onto
d03bd989 682# # it. It also checks for duplicates as well
683# # 'add' => 'add_after_method_modifier'
684# }
fb1e11d5 685# );
d03bd989 686#
fb1e11d5 687# has 'around_method_modifiers' => (
a40b446a 688# metaclass => 'Hash',
fb1e11d5 689# reader =>'get_around_method_modifiers_map',
690# isa => 'HashRef[ArrayRef[CodeRef]]',
691# provides => {
692# 'keys' => 'get_around_method_modifiers',
d03bd989 693# 'exists' => 'has_around_method_modifiers',
694# # This actually makes sure there is an
fb1e11d5 695# # ARRAY at the given key, and pushed onto
d03bd989 696# # it. It also checks for duplicates as well
697# # 'add' => 'add_around_method_modifier'
698# }
fb1e11d5 699# );
d03bd989 700#
fb1e11d5 701# # override is similar to the other modifiers
702# # except that it is not an ARRAY of code refs
703# # but instead just a single name->code mapping
d03bd989 704#
fb1e11d5 705# has 'override_method_modifiers' => (
a40b446a 706# metaclass => 'Hash',
fb1e11d5 707# reader =>'get_override_method_modifiers_map',
d03bd989 708# isa => 'HashRef[CodeRef]',
fb1e11d5 709# provides => {
710# 'keys' => 'get_override_method_modifier',
d03bd989 711# 'exists' => 'has_override_method_modifier',
712# 'add' => 'add_override_method_modifier', # checks for local method ..
fb1e11d5 713# }
714# );
d03bd989 715#
fb1e11d5 716#####################################################################
717
718
e185c027 7191;
720
721__END__
722
723=pod
724
725=head1 NAME
726
727Moose::Meta::Role - The Moose Role metaclass
728
729=head1 DESCRIPTION
730
705d4cfd 731This class is a subclass of L<Class::MOP::Module> that provides
732additional Moose-specific functionality.
733
734It's API looks a lot like L<Moose::Meta::Class>, but internally it
735implements many things differently. This may change in the future.
79592a54 736
cf3bb5c5 737=head1 INHERITANCE
738
739C<Moose::Meta::Role> is a subclass of L<Class::MOP::Module>.
740
e185c027 741=head1 METHODS
742
705d4cfd 743=head2 Construction
744
e185c027 745=over 4
746
705d4cfd 747=item B<< Moose::Meta::Role->initialize($role_name) >>
e185c027 748
705d4cfd 749This method creates a new role object with the provided name.
e185c027 750
705d4cfd 751=item B<< Moose::Meta::Role->combine( [ $role => { ... } ], [ $role ], ... ) >>
78cd1d3b 752
705d4cfd 753This method accepts a list of array references. Each array reference
560c498d 754should contain a role name or L<Moose::Meta::Role> object as its first element. The second element is
c8b8d92f 755an optional hash reference. The hash reference can contain C<-excludes>
756and C<-alias> keys to control how methods are composed from the role.
e606ae5f 757
705d4cfd 758The return value is a new L<Moose::Meta::Role::Composite> that
759represents the combined roles.
db1ab48d 760
4701ceff 761=item B<< $metarole->composition_class_roles >>
762
763When combining multiple roles using C<combine>, this method is used to obtain a
764list of role names to be applied to the L<Moose::Meta::Role::Composite>
765instance returned by C<combine>. The default implementation returns an empty
766list. Extensions that need to hook into role combination may wrap this method
767to return additional role names.
768
705d4cfd 769=item B<< Moose::Meta::Role->create($name, %options) >>
e185c027 770
705d4cfd 771This method is identical to the L<Moose::Meta::Class> C<create>
772method.
773
774=item B<< Moose::Meta::Role->create_anon_role >>
e185c027 775
705d4cfd 776This method is identical to the L<Moose::Meta::Class>
777C<create_anon_class> method.
e185c027 778
705d4cfd 779=item B<< $metarole->is_anon_role >>
e185c027 780
705d4cfd 781Returns true if the role is an anonymous role.
e185c027 782
c23885b1 783=item B<< $metarole->consumers >>
784
785Returns a list of names of classes and roles which consume this role.
786
e185c027 787=back
788
705d4cfd 789=head2 Role application
790
e185c027 791=over 4
792
705d4cfd 793=item B<< $metarole->apply( $thing, @options ) >>
80572233 794
705d4cfd 795This method applies a role to the given C<$thing>. That can be another
796L<Moose::Meta::Role>, object, a L<Moose::Meta::Class> object, or a
797(non-meta) object instance.
80572233 798
705d4cfd 799The options are passed directly to the constructor for the appropriate
800L<Moose::Meta::Role::Application> subclass.
80572233 801
d05235e1 802Note that this will apply the role even if the C<$thing> in question already
803C<does> this role. L<Moose::Util/does_role> is a convenient wrapper for
804finding out if role application is necessary.
805
80572233 806=back
807
705d4cfd 808=head2 Roles and other roles
809
80572233 810=over 4
811
705d4cfd 812=item B<< $metarole->get_roles >>
d79e62fd 813
705d4cfd 814This returns an array reference of roles which this role does. This
815list may include duplicates.
d79e62fd 816
705d4cfd 817=item B<< $metarole->calculate_all_roles >>
d79e62fd 818
705d4cfd 819This returns a I<unique> list of all roles that this role does, and
820all the roles that its roles do.
d79e62fd 821
560c498d 822=item B<< $metarole->does_role($role) >>
2b14ac61 823
560c498d 824Given a role I<name> or L<Moose::Meta::Role> object, returns true if this role
825does the given role.
d79e62fd 826
705d4cfd 827=item B<< $metarole->add_role($role) >>
d79e62fd 828
705d4cfd 829Given a L<Moose::Meta::Role> object, this adds the role to the list of
830roles that the role does.
68efb014 831
705d4cfd 832=item B<< $metarole->get_excluded_roles_list >>
be4427d0 833
705d4cfd 834Returns a list of role names which this role excludes.
e185c027 835
705d4cfd 836=item B<< $metarole->excludes_role($role_name) >>
e185c027 837
705d4cfd 838Given a role I<name>, returns true if this role excludes the named
839role.
e606ae5f 840
705d4cfd 841=item B<< $metarole->add_excluded_roles(@role_names) >>
e606ae5f 842
705d4cfd 843Given one or more role names, adds those roles to the list of excluded
844roles.
bdabd620 845
705d4cfd 846=back
e185c027 847
705d4cfd 848=head2 Methods
093b12c2 849
705d4cfd 850The methods for dealing with a role's methods are all identical in API
851and behavior to the same methods in L<Class::MOP::Class>.
638853cb 852
705d4cfd 853=over 4
53dd42d8 854
705d4cfd 855=item B<< $metarole->method_metaclass >>
e185c027 856
705d4cfd 857Returns the method metaclass name for the role. This defaults to
858L<Moose::Meta::Role::Method>.
e185c027 859
705d4cfd 860=item B<< $metarole->get_method($name) >>
e185c027 861
705d4cfd 862=item B<< $metarole->has_method($name) >>
e185c027 863
705d4cfd 864=item B<< $metarole->add_method( $name, $body ) >>
e185c027 865
705d4cfd 866=item B<< $metarole->get_method_list >>
e185c027 867
705d4cfd 868=item B<< $metarole->find_method_by_name($name) >>
869
870These methods are all identical to the methods of the same name in
8f6cbfcd 871L<Class::MOP::Package>
e185c027 872
873=back
874
705d4cfd 875=head2 Attributes
876
877As with methods, the methods for dealing with a role's attribute are
878all identical in API and behavior to the same methods in
879L<Class::MOP::Class>.
880
881However, attributes stored in this class are I<not> stored as
882objects. Rather, the attribute definition is stored as a hash
883reference. When a role is composed into a class, this hash reference
884is passed directly to the metaclass's C<add_attribute> method.
885
886This is quite likely to change in the future.
887
e185c027 888=over 4
889
705d4cfd 890=item B<< $metarole->get_attribute($attribute_name) >>
891
892=item B<< $metarole->has_attribute($attribute_name) >>
1331430a 893
705d4cfd 894=item B<< $metarole->get_attribute_list >>
1331430a 895
705d4cfd 896=item B<< $metarole->add_attribute($name, %options) >>
1331430a 897
705d4cfd 898=item B<< $metarole->remove_attribute($attribute_name) >>
1331430a 899
900=back
901
705d4cfd 902=head2 Required methods
903
0558683c 904=over 4
905
705d4cfd 906=item B<< $metarole->get_required_method_list >>
0558683c 907
705d4cfd 908Returns the list of methods required by the role.
0558683c 909
705d4cfd 910=item B<< $metarole->requires_method($name) >>
0558683c 911
705d4cfd 912Returns true if the role requires the named method.
0558683c 913
0ecff16b 914=item B<< $metarole->add_required_methods(@names) >>
0558683c 915
b3c1586a 916Adds the named methods to the role's list of required methods.
0558683c 917
705d4cfd 918=item B<< $metarole->remove_required_methods(@names) >>
0558683c 919
2dda1d28 920Removes the named methods from the role's list of required methods.
0558683c 921
bb153262 922=item B<< $metarole->add_conflicting_method(%params) >>
09eeab06 923
bb153262 924Instantiate the parameters as a L<Moose::Meta::Role::Method::Conflicting>
09eeab06 925object, then add it to the required method list.
926
705d4cfd 927=back
928
929=head2 Method modifiers
0558683c 930
fa907f2e 931These methods act like their counterparts in L<Class::MOP::Class> and
705d4cfd 932L<Moose::Meta::Class>.
933
934However, method modifiers are simply stored internally, and are not
935applied until the role itself is applied to a class.
0558683c 936
937=over 4
938
705d4cfd 939=item B<< $metarole->add_after_method_modifier($method_name, $method) >>
0558683c 940
705d4cfd 941=item B<< $metarole->add_around_method_modifier($method_name, $method) >>
0558683c 942
705d4cfd 943=item B<< $metarole->add_before_method_modifier($method_name, $method) >>
0558683c 944
705d4cfd 945=item B<< $metarole->add_override_method_modifier($method_name, $method) >>
0558683c 946
705d4cfd 947These methods all add an appropriate modifier to the internal list of
948modifiers.
0558683c 949
705d4cfd 950=item B<< $metarole->has_after_method_modifiers >>
0558683c 951
705d4cfd 952=item B<< $metarole->has_around_method_modifiers >>
953
954=item B<< $metarole->has_before_method_modifiers >>
955
956=item B<< $metarole->has_override_method_modifier >>
0558683c 957
705d4cfd 958Return true if the role has any modifiers of the given type.
0558683c 959
705d4cfd 960=item B<< $metarole->get_after_method_modifiers($method_name) >>
0558683c 961
705d4cfd 962=item B<< $metarole->get_around_method_modifiers($method_name) >>
0558683c 963
705d4cfd 964=item B<< $metarole->get_before_method_modifiers($method_name) >>
0558683c 965
705d4cfd 966Given a method name, returns a list of the appropriate modifiers for
967that method.
968
969=item B<< $metarole->get_override_method_modifier($method_name) >>
970
971Given a method name, returns the override method modifier for that
972method, if it has one.
0558683c 973
974=back
975
705d4cfd 976=head2 Introspection
505065c4 977
705d4cfd 978=over 4
505065c4 979
705d4cfd 980=item B<< Moose::Meta::Role->meta >>
505065c4 981
705d4cfd 982This will return a L<Class::MOP::Class> instance for this class.
505065c4 983
984=back
985
e185c027 986=head1 BUGS
987
d4048ef3 988See L<Moose/BUGS> for details on reporting bugs.
e185c027 989
990=head1 AUTHOR
991
992Stevan Little E<lt>stevan@iinteractive.comE<gt>
993
994=head1 COPYRIGHT AND LICENSE
995
7e0492d3 996Copyright 2006-2010 by Infinity Interactive, Inc.
e185c027 997
998L<http://www.iinteractive.com>
999
1000This library is free software; you can redistribute it and/or modify
fb1e11d5 1001it under the same terms as Perl itself.
e185c027 1002
b8aeb4dc 1003=cut