2 package Moose::Meta::Class;
10 use Scalar::Util 'weaken', 'blessed', 'reftype';
12 our $VERSION = '0.22';
13 our $AUTHORITY = 'cpan:STEVAN';
15 use Moose::Meta::Method::Overriden;
16 use Moose::Meta::Method::Augmented;
18 use base 'Class::MOP::Class';
20 __PACKAGE__->meta->add_attribute('roles' => (
28 $class->SUPER::initialize($pkg,
29 'attribute_metaclass' => 'Moose::Meta::Attribute',
30 'method_metaclass' => 'Moose::Meta::Method',
31 'instance_metaclass' => 'Moose::Meta::Instance',
36 my ($self, $package_name, %options) = @_;
38 (ref $options{roles} eq 'ARRAY')
39 || confess "You must pass an ARRAY ref of roles"
40 if exists $options{roles};
42 my $class = $self->SUPER::create($package_name, %options);
44 if (exists $options{roles}) {
45 Moose::Util::apply_all_roles($class, @{$options{roles}});
53 sub create_anon_class {
54 my ($self, %options) = @_;
56 my $cache_ok = delete $options{cache};
58 # something like Super::Class|Super::Class::2=Role|Role::1
59 my $cache_key = join '=' => (
60 join('|', sort @{$options{superclasses} || []}),
61 join('|', sort @{$options{roles} || []}),
64 if ($cache_ok && defined $ANON_CLASSES{$cache_key}) {
65 return $ANON_CLASSES{$cache_key};
68 my $new_class = $self->SUPER::create_anon_class(%options);
70 $ANON_CLASSES{$cache_key} = $new_class
77 my ($self, $role) = @_;
78 (blessed($role) && $role->isa('Moose::Meta::Role'))
79 || confess "Roles must be instances of Moose::Meta::Role";
80 push @{$self->roles} => $role;
83 sub calculate_all_roles {
86 grep { !$seen{$_->name}++ } map { $_->calculate_all_roles } @{ $self->roles };
90 my ($self, $role_name) = @_;
92 || confess "You must supply a role name to look for";
93 foreach my $class ($self->class_precedence_list) {
94 next unless $class->can('meta') && $class->meta->can('roles');
95 foreach my $role (@{$class->meta->roles}) {
96 return 1 if $role->does_role($role_name);
103 my ($self, $role_name) = @_;
105 || confess "You must supply a role name to look for";
106 foreach my $class ($self->class_precedence_list) {
107 next unless $class->can('meta');
109 # in the pretty rare instance when a Moose metaclass
110 # is itself extended with a role, this check needs to
111 # be done since some items in the class_precedence_list
112 # might in fact be Class::MOP based still.
113 next unless $class->meta->can('roles');
114 foreach my $role (@{$class->meta->roles}) {
115 return 1 if $role->excludes_role($role_name);
122 my ($class, %params) = @_;
123 my $self = $class->SUPER::new_object(%params);
124 foreach my $attr ($class->compute_all_applicable_attributes()) {
125 # if we have a trigger, then ...
126 if ($attr->can('has_trigger') && $attr->has_trigger) {
127 # make sure we have an init-arg ...
128 if (defined(my $init_arg = $attr->init_arg)) {
129 # now make sure an init-arg was passes ...
130 if (exists $params{$init_arg}) {
131 # and if get here, fire the trigger
134 # check if there is a coercion
135 ($attr->should_coerce
136 # and if so, we need to grab the
137 # value that is actually been stored
138 ? $attr->get_read_method_ref->($self)
139 # otherwise, just get the value from
140 # the constructor params
141 : $params{$init_arg}),
151 sub construct_instance {
152 my ($class, %params) = @_;
153 my $meta_instance = $class->get_meta_instance;
155 # the code below is almost certainly incorrect
156 # but this is foreign inheritence, so we might
157 # have to kludge it in the end.
158 my $instance = $params{'__INSTANCE__'} || $meta_instance->create_instance();
159 foreach my $attr ($class->compute_all_applicable_attributes()) {
160 $attr->initialize_instance_slot($meta_instance, $instance, \%params);
170 if (defined $self->{'$!_package_cache_flag'} &&
171 $self->{'$!_package_cache_flag'} == Class::MOP::check_package_cache_flag($self->meta->name)) {
172 return $self->{'%!methods'};
175 my $map = $self->{'%!methods'};
177 my $class_name = $self->name;
178 my $method_metaclass = $self->method_metaclass;
180 foreach my $symbol ($self->list_all_package_symbols('CODE')) {
182 my $code = $self->get_package_symbol('&' . $symbol);
184 next if exists $map->{$symbol} &&
185 defined $map->{$symbol} &&
186 $map->{$symbol}->body == $code;
188 my ($pkg, $name) = Class::MOP::get_code_info($code);
190 if ($pkg->can('meta')
192 # we don't know what ->meta we are calling
193 # here, so we need to be careful cause it
194 # just might blow up at us, or just complain
195 # loudly (in the case of Curses.pm) so we
196 # just be a little overly cautious here.
198 && eval { no warnings; blessed($pkg->meta) }
199 && $pkg->meta->isa('Moose::Meta::Role')) {
200 #my $role = $pkg->meta->name;
201 #next unless $self->does_role($role);
204 next if ($pkg || '') ne $class_name &&
205 ($name || '') ne '__ANON__';
209 $map->{$symbol} = $method_metaclass->wrap($code);
215 ### ---------------------------------------------
219 $self->SUPER::add_attribute(
220 (blessed $_[0] && $_[0]->isa('Class::MOP::Attribute')
222 : $self->_process_attribute(@_))
226 sub add_override_method_modifier {
227 my ($self, $name, $method, $_super_package) = @_;
229 (!$self->has_method($name))
230 || confess "Cannot add an override method if a local method is already present";
232 $self->add_method($name => Moose::Meta::Method::Overriden->new(
235 package => $_super_package, # need this for roles
240 sub add_augment_method_modifier {
241 my ($self, $name, $method) = @_;
242 (!$self->has_method($name))
243 || confess "Cannot add an augment method if a local method is already present";
245 $self->add_method($name => Moose::Meta::Method::Augmented->new(
252 ## Private Utility methods ...
254 sub _find_next_method_by_name_which_is_not_overridden {
255 my ($self, $name) = @_;
256 foreach my $method ($self->find_all_methods_by_name($name)) {
257 return $method->{code}
258 if blessed($method->{code}) && !$method->{code}->isa('Moose::Meta::Method::Overriden');
263 sub _fix_metaclass_incompatability {
264 my ($self, @superclasses) = @_;
265 foreach my $super (@superclasses) {
266 # don't bother if it does not have a meta.
267 next unless $super->can('meta');
268 # get the name, make sure we take
269 # immutable classes into account
270 my $super_meta_name = ($super->meta->is_immutable
271 ? $super->meta->get_mutable_metaclass_name
272 : blessed($super->meta));
273 # if it's meta is a vanilla Moose,
274 # then we can safely ignore it.
275 next if $super_meta_name eq 'Moose::Meta::Class';
276 # but if we have anything else,
277 # we need to check it out ...
278 unless (# see if of our metaclass is incompatible
279 ($self->isa($super_meta_name) &&
280 # and see if our instance metaclass is incompatible
281 $self->instance_metaclass->isa($super->meta->instance_metaclass)) &&
282 # ... and if we are just a vanilla Moose
283 $self->isa('Moose::Meta::Class')) {
284 # re-initialize the meta ...
285 my $super_meta = $super->meta;
287 # We might want to consider actually
288 # transfering any attributes from the
289 # original meta into this one, but in
290 # general you should not have any there
291 # at this point anyway, so it's very
292 # much an obscure edge case anyway
293 $self = $super_meta->reinitialize($self->name => (
294 'attribute_metaclass' => $super_meta->attribute_metaclass,
295 'method_metaclass' => $super_meta->method_metaclass,
296 'instance_metaclass' => $super_meta->instance_metaclass,
304 # this was crap anyway, see
305 # Moose::Util::apply_all_roles
307 sub _apply_all_roles {
308 Carp::croak 'DEPRECATED: use Moose::Util::apply_all_roles($meta, @roles) instead'
311 sub _process_attribute {
312 my ( $self, $name, @args ) = @_;
314 @args = %{$args[0]} if scalar @args == 1 && ref($args[0]) eq 'HASH';
316 if ($name =~ /^\+(.*)/) {
317 return $self->_process_inherited_attribute($1, @args);
320 return $self->_process_new_attribute($name, @args);
324 sub _process_new_attribute {
325 my ( $self, $name, @args ) = @_;
327 $self->attribute_metaclass->interpolate_class_and_new($name, @args);
330 sub _process_inherited_attribute {
331 my ($self, $attr_name, %options) = @_;
332 my $inherited_attr = $self->find_attribute_by_name($attr_name);
333 (defined $inherited_attr)
334 || confess "Could not find an attribute by the name of '$attr_name' to inherit from";
335 if ($inherited_attr->isa('Moose::Meta::Attribute')) {
336 return $inherited_attr->clone_and_inherit_options(%options);
340 # kind of a kludge to handle Class::MOP::Attributes
341 return $inherited_attr->Moose::Meta::Attribute::clone_and_inherit_options(%options);
345 ## -------------------------------------------------
347 use Moose::Meta::Method::Constructor;
348 use Moose::Meta::Method::Destructor;
350 # This could be done by using SUPER and altering ->options
351 # I am keeping it this way to make it more explicit.
352 sub create_immutable_transformer {
354 my $class = Class::MOP::Immutable->new($self, {
355 read_only => [qw/superclasses/],
362 remove_package_symbol
366 class_precedence_list => 'ARRAY',
367 compute_all_applicable_attributes => 'ARRAY',
368 get_meta_instance => 'SCALAR',
369 get_method_map => 'SCALAR',
371 calculate_all_roles => 'ARRAY',
374 # this is ugly, but so are typeglobs,
375 # so whattayahgonnadoboutit
378 add_package_symbol => sub {
379 my $original = shift;
380 confess "Cannot add package symbols to an immutable metaclass"
381 unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol';
382 goto $original->body;
391 $self->SUPER::make_immutable
393 constructor_class => 'Moose::Meta::Method::Constructor',
394 destructor_class => 'Moose::Meta::Method::Destructor',
395 inline_destructor => 1,
397 # no need to do this,
398 # Moose always does it
399 inline_accessors => 0,
412 Moose::Meta::Class - The Moose metaclass
416 This is a subclass of L<Class::MOP::Class> with Moose specific
419 For the most part, the only time you will ever encounter an
420 instance of this class is if you are doing some serious deep
421 introspection. To really understand this class, you need to refer
422 to the L<Class::MOP::Class> documentation.
432 Overrides original to accept a list of roles to apply to
435 my $metaclass = Moose::Meta::Class->create( 'New::Class', roles => [...] );
437 =item B<create_anon_class>
439 Overrides original to support roles and caching.
441 my $metaclass = Moose::Meta::Class->create_anon_class(
442 superclasses => ['Foo'],
443 roles => [qw/Some Roles Go Here/],
447 =item B<make_immutable>
449 Override original to add default options for inlining destructor
450 and altering the Constructor metaclass.
452 =item B<create_immutable_transformer>
454 Override original to lock C<add_role> and memoize C<calculate_all_roles>
458 We override this method to support the C<trigger> attribute option.
460 =item B<construct_instance>
462 This provides some Moose specific extensions to this method, you
463 almost never call this method directly unless you really know what
466 This method makes sure to handle the moose weak-ref, type-constraint
467 and type coercion features.
469 =item B<get_method_map>
471 This accommodates Moose::Meta::Role::Method instances, which are
472 aliased, instead of added, but still need to be counted as valid
475 =item B<add_override_method_modifier ($name, $method)>
477 This will create an C<override> method modifier for you, and install
480 =item B<add_augment_method_modifier ($name, $method)>
482 This will create an C<augment> method modifier for you, and install
485 =item B<calculate_all_roles>
489 This will return an array of C<Moose::Meta::Role> instances which are
490 attached to this class.
492 =item B<add_role ($role)>
494 This takes an instance of C<Moose::Meta::Role> in C<$role>, and adds it
495 to the list of associated roles.
497 =item B<does_role ($role_name)>
499 This will test if this class C<does> a given C<$role_name>. It will
500 not only check it's local roles, but ask them as well in order to
501 cascade down the role hierarchy.
503 =item B<excludes_role ($role_name)>
505 This will test if this class C<excludes> a given C<$role_name>. It will
506 not only check it's local roles, but ask them as well in order to
507 cascade down the role hierarchy.
509 =item B<add_attribute ($attr_name, %params|$params)>
511 This method does the same thing as L<Class::MOP::Class::add_attribute>, but adds
512 support for taking the C<$params> as a HASH ref.
518 All complex software has bugs lurking in it, and this module is no
519 exception. If you find a bug please either email me, or add the bug
524 Stevan Little E<lt>stevan@iinteractive.comE<gt>
526 =head1 COPYRIGHT AND LICENSE
528 Copyright 2006-2008 by Infinity Interactive, Inc.
530 L<http://www.iinteractive.com>
532 This library is free software; you can redistribute it and/or modify
533 it under the same terms as Perl itself.