2 package Class::MOP::Class;
7 use Class::MOP::Immutable;
8 use Class::MOP::Instance;
9 use Class::MOP::Method::Wrapped;
12 use Scalar::Util 'blessed', 'weaken';
14 our $VERSION = '0.65';
15 our $AUTHORITY = 'cpan:STEVAN';
17 use base 'Class::MOP::Module';
27 $package_name = shift;
30 $package_name = $options{package};
33 (defined $package_name && $package_name && !ref($package_name))
34 || confess "You must pass a package name and it cannot be blessed";
36 return Class::MOP::get_metaclass_by_name($package_name)
37 || $class->construct_class_instance(package => $package_name, @_);
42 my $package_name = shift;
43 (defined $package_name && $package_name && !blessed($package_name))
44 || confess "You must pass a package name and it cannot be blessed";
45 Class::MOP::remove_metaclass_by_name($package_name);
46 $class->construct_class_instance('package' => $package_name, @_);
49 # NOTE: (meta-circularity)
50 # this is a special form of &construct_instance
51 # (see below), which is used to construct class
52 # meta-object instances for any Class::MOP::*
53 # class. All other classes will use the more
54 # normal &construct_instance.
55 sub construct_class_instance {
58 my $package_name = $options{'package'};
59 (defined $package_name && $package_name)
60 || confess "You must pass a package name";
62 # return the metaclass if we have it cached,
63 # and it is still defined (it has not been
64 # reaped by DESTROY yet, which can happen
65 # annoyingly enough during global destruction)
67 if (defined(my $meta = Class::MOP::get_metaclass_by_name($package_name))) {
72 # we need to deal with the possibility
73 # of class immutability here, and then
74 # get the name of the class appropriately
76 ? ($class->is_immutable
77 ? $class->get_mutable_metaclass_name()
81 # now create the metaclass
83 if ($class eq 'Class::MOP::Class') {
85 $meta = $class->_new(%options)
89 # it is safe to use meta here because
90 # class will always be a subclass of
91 # Class::MOP::Class, which defines meta
92 $meta = $class->meta->construct_instance(%options)
95 # and check the metaclass compatibility
96 $meta->check_metaclass_compatability();
98 Class::MOP::store_metaclass_by_name($package_name, $meta);
101 # we need to weaken any anon classes
102 # so that they can call DESTROY properly
103 Class::MOP::weaken_metaclass($package_name) if $meta->is_anon_class;
109 my ( $class, %options ) = @_;
111 # inherited from Class::MOP::Package
112 'package' => $options{package},
115 # since the following attributes will
116 # actually be loaded from the symbol
117 # table, and actually bypass the instance
118 # entirely, we can just leave these things
119 # listed here for reference, because they
120 # should not actually have a value associated
122 'namespace' => \undef,
123 # inherited from Class::MOP::Module
125 'authority' => \undef,
126 # defined in Class::MOP::Class
127 'superclasses' => \undef,
131 'attribute_metaclass' => $options{'attribute_metaclass'} || 'Class::MOP::Attribute',
132 'method_metaclass' => $options{'method_metaclass'} || 'Class::MOP::Method',
133 'instance_metaclass' => $options{'instance_metaclass'} || 'Class::MOP::Instance',
137 sub reset_package_cache_flag { (shift)->{'_package_cache_flag'} = undef }
138 sub update_package_cache_flag {
141 # we can manually update the cache number
142 # since we are actually adding the method
143 # to our cache as well. This avoids us
144 # having to regenerate the method_map.
146 $self->{'_package_cache_flag'} = Class::MOP::check_package_cache_flag($self->name);
149 sub check_metaclass_compatability {
152 # this is always okay ...
153 return if ref($self) eq 'Class::MOP::Class' &&
154 $self->instance_metaclass eq 'Class::MOP::Instance';
156 my @class_list = $self->linearized_isa;
157 shift @class_list; # shift off $self->name
159 foreach my $class_name (@class_list) {
160 my $meta = Class::MOP::get_metaclass_by_name($class_name) || next;
163 # we need to deal with the possibility
164 # of class immutability here, and then
165 # get the name of the class appropriately
166 my $meta_type = ($meta->is_immutable
167 ? $meta->get_mutable_metaclass_name()
170 ($self->isa($meta_type))
171 || confess $self->name . "->meta => (" . (ref($self)) . ")" .
172 " is not compatible with the " .
173 $class_name . "->meta => (" . ($meta_type) . ")";
175 # we also need to check that instance metaclasses
176 # are compatabile in the same the class.
177 ($self->instance_metaclass->isa($meta->instance_metaclass))
178 || confess $self->name . "->meta => (" . ($self->instance_metaclass) . ")" .
179 " is not compatible with the " .
180 $class_name . "->meta => (" . ($meta->instance_metaclass) . ")";
188 # this should be sufficient, if you have a
189 # use case where it is not, write a test and
191 my $ANON_CLASS_SERIAL = 0;
194 # we need a sufficiently annoying prefix
195 # this should suffice for now, this is
196 # used in a couple of places below, so
197 # need to put it up here for now.
198 my $ANON_CLASS_PREFIX = 'Class::MOP::Class::__ANON__::SERIAL::';
202 no warnings 'uninitialized';
203 $self->name =~ /^$ANON_CLASS_PREFIX/;
206 sub create_anon_class {
207 my ($class, %options) = @_;
208 my $package_name = $ANON_CLASS_PREFIX . ++$ANON_CLASS_SERIAL;
209 return $class->create($package_name, %options);
213 # this will only get called for
214 # anon-classes, all other calls
215 # are assumed to occur during
216 # global destruction and so don't
217 # really need to be handled explicitly
221 return if Class::MOP::in_global_destruction; # it'll happen soon anyway and this just makes things more complicated
223 no warnings 'uninitialized';
224 return unless $self->name =~ /^$ANON_CLASS_PREFIX/;
225 my ($serial_id) = ($self->name =~ /^$ANON_CLASS_PREFIX(\d+)/);
227 foreach my $key (keys %{$ANON_CLASS_PREFIX . $serial_id}) {
228 delete ${$ANON_CLASS_PREFIX . $serial_id}{$key};
230 delete ${'main::' . $ANON_CLASS_PREFIX}{$serial_id . '::'};
235 # creating classes with MOP ...
238 my ( $class, @args ) = @_;
240 unshift @args, 'package' if @args % 2 == 1;
242 my (%options) = @args;
243 my $package_name = $options{package};
245 (defined $package_name && $package_name)
246 || confess "You must pass a package name";
248 (ref $options{superclasses} eq 'ARRAY')
249 || confess "You must pass an ARRAY ref of superclasses"
250 if exists $options{superclasses};
252 (ref $options{attributes} eq 'ARRAY')
253 || confess "You must pass an ARRAY ref of attributes"
254 if exists $options{attributes};
256 (ref $options{methods} eq 'HASH')
257 || confess "You must pass an HASH ref of methods"
258 if exists $options{methods};
260 my $code = "package $package_name;";
261 $code .= "\$$package_name\:\:VERSION = '" . $options{version} . "';"
262 if exists $options{version};
263 $code .= "\$$package_name\:\:AUTHORITY = '" . $options{authority} . "';"
264 if exists $options{authority};
267 confess "creation of $package_name failed : $@" if $@;
269 my $meta = $class->initialize($package_name);
272 $meta->add_method('meta' => sub {
273 $class->initialize(ref($_[0]) || $_[0]);
276 $meta->superclasses(@{$options{superclasses}})
277 if exists $options{superclasses};
279 # process attributes first, so that they can
280 # install accessors, but locally defined methods
281 # can then overwrite them. It is maybe a little odd, but
282 # I think this should be the order of things.
283 if (exists $options{attributes}) {
284 foreach my $attr (@{$options{attributes}}) {
285 $meta->add_attribute($attr);
288 if (exists $options{methods}) {
289 foreach my $method_name (keys %{$options{methods}}) {
290 $meta->add_method($method_name, $options{methods}->{$method_name});
299 # all these attribute readers will be bootstrapped
300 # away in the Class::MOP bootstrap section
302 sub get_attribute_map { $_[0]->{'attributes'} }
303 sub attribute_metaclass { $_[0]->{'attribute_metaclass'} }
304 sub method_metaclass { $_[0]->{'method_metaclass'} }
305 sub instance_metaclass { $_[0]->{'instance_metaclass'} }
308 # this is a prime canidate for conversion to XS
312 my $current = Class::MOP::check_package_cache_flag($self->name);
314 if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
315 return $self->{'methods'};
318 $self->{_package_cache_flag} = $current;
320 my $map = $self->{'methods'};
322 my $class_name = $self->name;
323 my $method_metaclass = $self->method_metaclass;
325 my %all_code = $self->get_all_package_symbols('CODE');
327 foreach my $symbol (keys %all_code) {
328 my $code = $all_code{$symbol};
330 next if exists $map->{$symbol} &&
331 defined $map->{$symbol} &&
332 $map->{$symbol}->body == $code;
334 my ($pkg, $name) = Class::MOP::get_code_info($code);
337 # in 5.10 constant.pm the constants show up
338 # as being in the right package, but in pre-5.10
339 # they show up as constant::__ANON__ so we
340 # make an exception here to be sure that things
341 # work as expected in both.
343 unless ($pkg eq 'constant' && $name eq '__ANON__') {
344 next if ($pkg || '') ne $class_name ||
345 (($name || '') ne '__ANON__' && ($pkg || '') ne $class_name);
348 $map->{$symbol} = $method_metaclass->wrap(
350 associated_metaclass => $self,
351 package_name => $class_name,
359 # Instance Construction & Cloning
365 # we need to protect the integrity of the
366 # Class::MOP::Class singletons here, so we
367 # delegate this to &construct_class_instance
368 # which will deal with the singletons
369 return $class->construct_class_instance(@_)
370 if $class->name->isa('Class::MOP::Class');
371 return $class->construct_instance(@_);
374 sub construct_instance {
375 my ($class, %params) = @_;
376 my $meta_instance = $class->get_meta_instance();
377 my $instance = $meta_instance->create_instance();
378 foreach my $attr ($class->compute_all_applicable_attributes()) {
379 $attr->initialize_instance_slot($meta_instance, $instance, \%params);
382 # this will only work for a HASH instance type
383 if ($class->is_anon_class) {
384 (Scalar::Util::reftype($instance) eq 'HASH')
385 || confess "Currently only HASH based instances are supported with instance of anon-classes";
387 # At some point we should make this official
388 # as a reserved slot name, but right now I am
389 # going to keep it here.
390 # my $RESERVED_MOP_SLOT = '__MOP__';
391 $instance->{'__MOP__'} = $class;
397 sub get_meta_instance {
399 $self->{'_meta_instance'} ||= $self->create_meta_instance();
402 sub create_meta_instance {
405 my $instance = $self->instance_metaclass->new(
406 associated_metaclass => $self,
407 attributes => [ $self->compute_all_applicable_attributes() ],
410 $self->add_meta_instance_dependencies()
411 if $instance->is_dependent_on_superclasses();
418 my $instance = shift;
419 (blessed($instance) && $instance->isa($class->name))
420 || confess "You must pass an instance of the metaclass (" . (ref $class ? $class->name : $class) . "), not ($instance)";
423 # we need to protect the integrity of the
424 # Class::MOP::Class singletons here, they
425 # should not be cloned.
426 return $instance if $instance->isa('Class::MOP::Class');
427 $class->clone_instance($instance, @_);
431 my ($class, $instance, %params) = @_;
433 || confess "You can only clone instances, ($instance) is not a blessed instance";
434 my $meta_instance = $class->get_meta_instance();
435 my $clone = $meta_instance->clone_instance($instance);
436 foreach my $attr ($class->compute_all_applicable_attributes()) {
437 if ( defined( my $init_arg = $attr->init_arg ) ) {
438 if (exists $params{$init_arg}) {
439 $attr->set_value($clone, $params{$init_arg});
446 sub rebless_instance {
447 my ($self, $instance, %params) = @_;
450 if ($instance->can('meta')) {
451 ($instance->meta->isa('Class::MOP::Class'))
452 || confess 'Cannot rebless instance if ->meta is not an instance of Class::MOP::Class';
453 $old_metaclass = $instance->meta;
456 $old_metaclass = $self->initialize(ref($instance));
459 my $meta_instance = $self->get_meta_instance();
461 $self->name->isa($old_metaclass->name)
462 || confess "You may rebless only into a subclass of (". $old_metaclass->name ."), of which (". $self->name .") isn't.";
465 $meta_instance->rebless_instance_structure($instance, $self);
467 foreach my $attr ( $self->compute_all_applicable_attributes ) {
468 if ( $attr->has_value($instance) ) {
469 if ( defined( my $init_arg = $attr->init_arg ) ) {
470 $params{$init_arg} = $attr->get_value($instance)
471 unless exists $params{$init_arg};
474 $attr->set_value($instance, $attr->get_value($instance));
479 foreach my $attr ($self->compute_all_applicable_attributes) {
480 $attr->initialize_instance_slot($meta_instance, $instance, \%params);
490 my $var_spec = { sigil => '@', type => 'ARRAY', name => 'ISA' };
493 @{$self->get_package_symbol($var_spec)} = @supers;
495 # we need to check the metaclass
496 # compatibility here so that we can
497 # be sure that the superclass is
498 # not potentially creating an issues
499 # we don't know about
500 $self->check_metaclass_compatability();
501 $self->update_meta_instance_dependencies();
503 @{$self->get_package_symbol($var_spec)};
509 my $super_class = $self->name;
511 if ( Class::MOP::HAVE_ISAREV() ) {
512 return @{ $super_class->mro::get_isarev() };
516 my $find_derived_classes;
517 $find_derived_classes = sub {
518 my ($outer_class) = @_;
520 my $symbol_table_hashref = do { no strict 'refs'; \%{"${outer_class}::"} };
523 for my $symbol ( keys %$symbol_table_hashref ) {
524 next SYMBOL if $symbol !~ /\A (\w+):: \z/x;
525 my $inner_class = $1;
527 next SYMBOL if $inner_class eq 'SUPER'; # skip '*::SUPER'
531 ? "${outer_class}::$inner_class"
534 if ( $class->isa($super_class) and $class ne $super_class ) {
535 push @derived_classes, $class;
538 next SYMBOL if $class eq 'main'; # skip 'main::*'
540 $find_derived_classes->($class);
544 my $root_class = q{};
545 $find_derived_classes->($root_class);
547 undef $find_derived_classes;
549 @derived_classes = sort { $a->isa($b) ? 1 : $b->isa($a) ? -1 : 0 } @derived_classes;
551 return @derived_classes;
557 return @{ mro::get_linear_isa( (shift)->name ) };
560 sub class_precedence_list {
562 my $name = $self->name;
564 unless (Class::MOP::IS_RUNNING_ON_5_10()) {
566 # We need to check for circular inheritance here
567 # if we are are not on 5.10, cause 5.8 detects it
568 # late. This will do nothing if all is well, and
569 # blow up otherwise. Yes, it's an ugly hack, better
570 # suggestions are welcome.
572 ($name || return)->isa('This is a test for circular inheritance')
575 # if our mro is c3, we can
576 # just grab the linear_isa
577 if (mro::get_mro($name) eq 'c3') {
578 return @{ mro::get_linear_isa($name) }
582 # we can't grab the linear_isa for dfs
583 # since it has all the duplicates
588 $self->initialize($_)->class_precedence_list()
589 } $self->superclasses()
597 my ($self, $method_name, $method) = @_;
598 (defined $method_name && $method_name)
599 || confess "You must define a method name";
602 if (blessed($method)) {
603 $body = $method->body;
604 if ($method->package_name ne $self->name &&
605 $method->name ne $method_name) {
606 warn "Hello there, got something for you."
607 . " Method says " . $method->package_name . " " . $method->name
608 . " Class says " . $self->name . " " . $method_name;
609 $method = $method->clone(
610 package_name => $self->name,
612 ) if $method->can('clone');
617 ('CODE' eq ref($body))
618 || confess "Your code block must be a CODE reference";
619 $method = $self->method_metaclass->wrap(
621 package_name => $self->name,
627 $method->attach_to_class($self);
629 $self->get_method_map->{$method_name} = $method;
631 my $full_method_name = ($self->name . '::' . $method_name);
632 $self->add_package_symbol(
633 { sigil => '&', type => 'CODE', name => $method_name },
634 Class::MOP::subname($full_method_name => $body)
637 $self->update_package_cache_flag; # still valid, since we just added the method to the map, and if it was invalid before that then get_method_map updated it
641 my $fetch_and_prepare_method = sub {
642 my ($self, $method_name) = @_;
644 my $method = $self->get_method($method_name);
645 # if we dont have local ...
647 # try to find the next method
648 $method = $self->find_next_method_by_name($method_name);
649 # die if it does not exist
651 || confess "The method '$method_name' is not found in the inheritance hierarchy for class " . $self->name;
652 # and now make sure to wrap it
653 # even if it is already wrapped
654 # because we need a new sub ref
655 $method = Class::MOP::Method::Wrapped->wrap($method);
658 # now make sure we wrap it properly
659 $method = Class::MOP::Method::Wrapped->wrap($method)
660 unless $method->isa('Class::MOP::Method::Wrapped');
662 $self->add_method($method_name => $method);
666 sub add_before_method_modifier {
667 my ($self, $method_name, $method_modifier) = @_;
668 (defined $method_name && $method_name)
669 || confess "You must pass in a method name";
670 my $method = $fetch_and_prepare_method->($self, $method_name);
671 $method->add_before_modifier(
672 Class::MOP::subname(':before' => $method_modifier)
676 sub add_after_method_modifier {
677 my ($self, $method_name, $method_modifier) = @_;
678 (defined $method_name && $method_name)
679 || confess "You must pass in a method name";
680 my $method = $fetch_and_prepare_method->($self, $method_name);
681 $method->add_after_modifier(
682 Class::MOP::subname(':after' => $method_modifier)
686 sub add_around_method_modifier {
687 my ($self, $method_name, $method_modifier) = @_;
688 (defined $method_name && $method_name)
689 || confess "You must pass in a method name";
690 my $method = $fetch_and_prepare_method->($self, $method_name);
691 $method->add_around_modifier(
692 Class::MOP::subname(':around' => $method_modifier)
697 # the methods above used to be named like this:
698 # ${pkg}::${method}:(before|after|around)
699 # but this proved problematic when using one modifier
700 # to wrap multiple methods (something which is likely
701 # to happen pretty regularly IMO). So instead of naming
702 # it like this, I have chosen to just name them purely
703 # with their modifier names, like so:
704 # :(before|after|around)
705 # The fact is that in a stack trace, it will be fairly
706 # evident from the context what method they are attached
707 # to, and so don't need the fully qualified name.
711 my ($self, $method_name, $method) = @_;
712 (defined $method_name && $method_name)
713 || confess "You must define a method name";
715 my $body = (blessed($method) ? $method->body : $method);
716 ('CODE' eq ref($body))
717 || confess "Your code block must be a CODE reference";
719 $self->add_package_symbol(
720 { sigil => '&', type => 'CODE', name => $method_name } => $body
725 my ($self, $method_name) = @_;
726 (defined $method_name && $method_name)
727 || confess "You must define a method name";
729 return 0 unless exists $self->get_method_map->{$method_name};
734 my ($self, $method_name) = @_;
735 (defined $method_name && $method_name)
736 || confess "You must define a method name";
739 # I don't really need this here, because
740 # if the method_map is missing a key it
741 # will just return undef for me now
742 # return unless $self->has_method($method_name);
744 return $self->get_method_map->{$method_name};
748 my ($self, $method_name) = @_;
749 (defined $method_name && $method_name)
750 || confess "You must define a method name";
752 my $removed_method = delete $self->get_method_map->{$method_name};
754 $self->remove_package_symbol(
755 { sigil => '&', type => 'CODE', name => $method_name }
758 $removed_method->detach_from_class if $removed_method;
760 $self->update_package_cache_flag; # still valid, since we just removed the method from the map
762 return $removed_method;
765 sub get_method_list {
767 keys %{$self->get_method_map};
770 sub find_method_by_name {
771 my ($self, $method_name) = @_;
772 (defined $method_name && $method_name)
773 || confess "You must define a method name to find";
774 foreach my $class ($self->linearized_isa) {
775 # fetch the meta-class ...
776 my $meta = $self->initialize($class);
777 return $meta->get_method($method_name)
778 if $meta->has_method($method_name);
783 sub get_all_methods {
785 my %methods = map { %{ $self->initialize($_)->get_method_map } } reverse $self->linearized_isa;
786 return values %methods;
790 sub compute_all_applicable_methods {
794 class => $_->package_name,
795 code => $_, # sigh, overloading
797 } shift->get_all_methods(@_);
800 sub find_all_methods_by_name {
801 my ($self, $method_name) = @_;
802 (defined $method_name && $method_name)
803 || confess "You must define a method name to find";
805 foreach my $class ($self->linearized_isa) {
806 # fetch the meta-class ...
807 my $meta = $self->initialize($class);
809 name => $method_name,
811 code => $meta->get_method($method_name)
812 } if $meta->has_method($method_name);
817 sub find_next_method_by_name {
818 my ($self, $method_name) = @_;
819 (defined $method_name && $method_name)
820 || confess "You must define a method name to find";
821 my @cpl = $self->linearized_isa;
822 shift @cpl; # discard ourselves
823 foreach my $class (@cpl) {
824 # fetch the meta-class ...
825 my $meta = $self->initialize($class);
826 return $meta->get_method($method_name)
827 if $meta->has_method($method_name);
836 # either we have an attribute object already
837 # or we need to create one from the args provided
838 my $attribute = blessed($_[0]) ? $_[0] : $self->attribute_metaclass->new(@_);
839 # make sure it is derived from the correct type though
840 ($attribute->isa('Class::MOP::Attribute'))
841 || confess "Your attribute must be an instance of Class::MOP::Attribute (or a subclass)";
843 # first we attach our new attribute
844 # because it might need certain information
845 # about the class which it is attached to
846 $attribute->attach_to_class($self);
848 # then we remove attributes of a conflicting
849 # name here so that we can properly detach
850 # the old attr object, and remove any
851 # accessors it would have generated
852 if ( $self->has_attribute($attribute->name) ) {
853 $self->remove_attribute($attribute->name);
855 $self->invalidate_meta_instances();
858 # then onto installing the new accessors
859 $self->get_attribute_map->{$attribute->name} = $attribute;
861 # invalidate package flag here
862 my $e = do { local $@; eval { $attribute->install_accessors() }; $@ };
864 $self->remove_attribute($attribute->name);
871 sub update_meta_instance_dependencies {
874 if ( $self->{meta_instance_dependencies} ) {
875 return $self->add_meta_instance_dependencies;
879 sub add_meta_instance_dependencies {
882 $self->remove_meta_instance_depdendencies;
884 my @attrs = $self->compute_all_applicable_attributes();
887 my @classes = grep { not $seen{$_->name}++ } map { $_->associated_class } @attrs;
889 foreach my $class ( @classes ) {
890 $class->add_dependent_meta_instance($self);
893 $self->{meta_instance_dependencies} = \@classes;
896 sub remove_meta_instance_depdendencies {
899 if ( my $classes = delete $self->{meta_instance_dependencies} ) {
900 foreach my $class ( @$classes ) {
901 $class->remove_dependent_meta_instance($self);
911 sub add_dependent_meta_instance {
912 my ( $self, $metaclass ) = @_;
913 push @{ $self->{dependent_meta_instances} }, $metaclass;
916 sub remove_dependent_meta_instance {
917 my ( $self, $metaclass ) = @_;
918 my $name = $metaclass->name;
919 @$_ = grep { $_->name ne $name } @$_ for $self->{dependent_meta_instances};
922 sub invalidate_meta_instances {
924 $_->invalidate_meta_instance() for $self, @{ $self->{dependent_meta_instances} };
927 sub invalidate_meta_instance {
929 undef $self->{_meta_instance};
933 my ($self, $attribute_name) = @_;
934 (defined $attribute_name && $attribute_name)
935 || confess "You must define an attribute name";
936 exists $self->get_attribute_map->{$attribute_name};
940 my ($self, $attribute_name) = @_;
941 (defined $attribute_name && $attribute_name)
942 || confess "You must define an attribute name";
943 return $self->get_attribute_map->{$attribute_name}
945 # this will return undef anyway, so no need ...
946 # if $self->has_attribute($attribute_name);
950 sub remove_attribute {
951 my ($self, $attribute_name) = @_;
952 (defined $attribute_name && $attribute_name)
953 || confess "You must define an attribute name";
954 my $removed_attribute = $self->get_attribute_map->{$attribute_name};
955 return unless defined $removed_attribute;
956 delete $self->get_attribute_map->{$attribute_name};
957 $self->invalidate_meta_instances();
958 $removed_attribute->remove_accessors();
959 $removed_attribute->detach_from_class();
960 return $removed_attribute;
963 sub get_attribute_list {
965 keys %{$self->get_attribute_map};
968 sub get_all_attributes {
969 shift->compute_all_applicable_attributes(@_);
972 sub compute_all_applicable_attributes {
974 my %attrs = map { %{ $self->initialize($_)->get_attribute_map } } reverse $self->linearized_isa;
975 return values %attrs;
978 sub find_attribute_by_name {
979 my ($self, $attr_name) = @_;
980 foreach my $class ($self->linearized_isa) {
981 # fetch the meta-class ...
982 my $meta = $self->initialize($class);
983 return $meta->get_attribute($attr_name)
984 if $meta->has_attribute($attr_name);
992 sub is_immutable { 0 }
995 # Why I changed this (groditi)
996 # - One Metaclass may have many Classes through many Metaclass instances
997 # - One Metaclass should only have one Immutable Transformer instance
998 # - Each Class may have different Immutabilizing options
999 # - Therefore each Metaclass instance may have different Immutabilizing options
1000 # - We need to store one Immutable Transformer instance per Metaclass
1001 # - We need to store one set of Immutable Transformer options per Class
1002 # - Upon make_mutable we may delete the Immutabilizing options
1003 # - We could clean the immutable Transformer instance when there is no more
1004 # immutable Classes of that type, but we can also keep it in case
1005 # another class with this same Metaclass becomes immutable. It is a case
1006 # of trading of storing an instance to avoid unnecessary instantiations of
1007 # Immutable Transformers. You may view this as a memory leak, however
1008 # Because we have few Metaclasses, in practice it seems acceptable
1009 # - To allow Immutable Transformers instances to be cleaned up we could weaken
1010 # the reference stored in $IMMUTABLE_TRANSFORMERS{$class} and ||= should DWIM
1014 my %IMMUTABLE_TRANSFORMERS;
1015 my %IMMUTABLE_OPTIONS;
1017 sub get_immutable_options {
1019 return if $self->is_mutable;
1020 confess "unable to find immutabilizing options"
1021 unless exists $IMMUTABLE_OPTIONS{$self->name};
1022 my %options = %{$IMMUTABLE_OPTIONS{$self->name}};
1023 delete $options{IMMUTABLE_TRANSFORMER};
1027 sub get_immutable_transformer {
1029 if( $self->is_mutable ){
1030 my $class = ref $self || $self;
1031 return $IMMUTABLE_TRANSFORMERS{$class} ||= $self->create_immutable_transformer;
1033 confess "unable to find transformer for immutable class"
1034 unless exists $IMMUTABLE_OPTIONS{$self->name};
1035 return $IMMUTABLE_OPTIONS{$self->name}->{IMMUTABLE_TRANSFORMER};
1038 sub make_immutable {
1042 my $transformer = $self->get_immutable_transformer;
1043 $transformer->make_metaclass_immutable($self, \%options);
1044 $IMMUTABLE_OPTIONS{$self->name} =
1045 { %options, IMMUTABLE_TRANSFORMER => $transformer };
1047 if( exists $options{debug} && $options{debug} ){
1048 print STDERR "# of Metaclass options: ", keys %IMMUTABLE_OPTIONS;
1049 print STDERR "# of Immutable transformers: ", keys %IMMUTABLE_TRANSFORMERS;
1057 return if $self->is_mutable;
1058 my $options = delete $IMMUTABLE_OPTIONS{$self->name};
1059 confess "unable to find immutabilizing options" unless ref $options;
1060 my $transformer = delete $options->{IMMUTABLE_TRANSFORMER};
1061 $transformer->make_metaclass_mutable($self, $options);
1066 sub create_immutable_transformer {
1068 my $class = Class::MOP::Immutable->new($self, {
1069 read_only => [qw/superclasses/],
1076 remove_package_symbol
1079 class_precedence_list => 'ARRAY',
1080 linearized_isa => 'ARRAY',
1081 compute_all_applicable_attributes => 'ARRAY',
1082 get_meta_instance => 'SCALAR',
1083 get_method_map => 'SCALAR',
1086 # this is ugly, but so are typeglobs,
1087 # so whattayahgonnadoboutit
1090 add_package_symbol => sub {
1091 my $original = shift;
1092 confess "Cannot add package symbols to an immutable metaclass"
1093 unless (caller(2))[3] eq 'Class::MOP::Package::get_package_symbol';
1094 goto $original->body;
1109 Class::MOP::Class - Class Meta Object
1113 # assuming that class Foo
1114 # has been defined, you can
1116 # use this for introspection ...
1118 # add a method to Foo ...
1119 Foo->meta->add_method('bar' => sub { ... })
1121 # get a list of all the classes searched
1122 # the method dispatcher in the correct order
1123 Foo->meta->class_precedence_list()
1125 # remove a method from Foo
1126 Foo->meta->remove_method('bar');
1128 # or use this to actually create classes ...
1130 Class::MOP::Class->create('Bar' => (
1132 superclasses => [ 'Foo' ],
1134 Class::MOP:::Attribute->new('$bar'),
1135 Class::MOP:::Attribute->new('$baz'),
1138 calculate_bar => sub { ... },
1139 construct_baz => sub { ... }
1145 This is the largest and currently most complex part of the Perl 5
1146 meta-object protocol. It controls the introspection and
1147 manipulation of Perl 5 classes (and it can create them too). The
1148 best way to understand what this module can do, is to read the
1149 documentation for each of it's methods.
1153 =head2 Self Introspection
1159 This will return a B<Class::MOP::Class> instance which is related
1160 to this class. Thereby allowing B<Class::MOP::Class> to actually
1163 As with B<Class::MOP::Attribute>, B<Class::MOP> will actually
1164 bootstrap this module by installing a number of attribute meta-objects
1165 into it's metaclass. This will allow this class to reap all the benifits
1166 of the MOP when subclassing it.
1170 =head2 Class construction
1172 These methods will handle creating B<Class::MOP::Class> objects,
1173 which can be used to both create new classes, and analyze
1174 pre-existing classes.
1176 This module will internally store references to all the instances
1177 you create with these methods, so that they do not need to be
1178 created any more than nessecary. Basically, they are singletons.
1182 =item B<create ($package_name,
1183 version =E<gt> ?$version,
1184 authority =E<gt> ?$authority,
1185 superclasses =E<gt> ?@superclasses,
1186 methods =E<gt> ?%methods,
1187 attributes =E<gt> ?%attributes)>
1189 This returns a B<Class::MOP::Class> object, bringing the specified
1190 C<$package_name> into existence and adding any of the C<$version>,
1191 C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to
1194 =item B<create_anon_class (superclasses =E<gt> ?@superclasses,
1195 methods =E<gt> ?%methods,
1196 attributes =E<gt> ?%attributes)>
1198 This will create an anonymous class, it works much like C<create> but
1199 it does not need a C<$package_name>. Instead it will create a suitably
1200 unique package name for you to stash things into.
1202 On very important distinction is that anon classes are destroyed once
1203 the metaclass they are attached to goes out of scope. In the DESTROY
1204 method, the created package will be removed from the symbol table.
1206 It is also worth noting that any instances created with an anon-class
1207 will keep a special reference to the anon-meta which will prevent the
1208 anon-class from going out of scope until all instances of it have also
1209 been destroyed. This however only works for HASH based instance types,
1210 as we use a special reserved slot (C<__MOP__>) to store this.
1212 =item B<initialize ($package_name, %options)>
1214 This initializes and returns returns a B<Class::MOP::Class> object
1215 for a given a C<$package_name>.
1217 =item B<reinitialize ($package_name, %options)>
1219 This removes the old metaclass, and creates a new one in it's place.
1220 Do B<not> use this unless you really know what you are doing, it could
1221 very easily make a very large mess of your program.
1223 =item B<construct_class_instance (%options)>
1225 This will construct an instance of B<Class::MOP::Class>, it is
1226 here so that we can actually "tie the knot" for B<Class::MOP::Class>
1227 to use C<construct_instance> once all the bootstrapping is done. This
1228 method is used internally by C<initialize> and should never be called
1229 from outside of that method really.
1231 =item B<check_metaclass_compatability>
1233 This method is called as the very last thing in the
1234 C<construct_class_instance> method. This will check that the
1235 metaclass you are creating is compatible with the metaclasses of all
1236 your ancestors. For more inforamtion about metaclass compatibility
1237 see the C<About Metaclass compatibility> section in L<Class::MOP>.
1239 =item B<update_package_cache_flag>
1241 This will reset the package cache flag for this particular metaclass
1242 it is basically the value of the C<Class::MOP::get_package_cache_flag>
1243 function. This is very rarely needed from outside of C<Class::MOP::Class>
1244 but in some cases you might want to use it, so it is here.
1246 =item B<reset_package_cache_flag>
1248 Clears the package cache flag to announce to the internals that we need
1249 to rebuild the method map.
1251 =item B<add_meta_instance_dependencies>
1253 Registers this class as dependent on its superclasses.
1255 Only superclasses from which this class inherits attributes will be added.
1257 =item B<remove_meta_instance_depdendencies>
1259 Unregisters this class from its superclasses.
1261 =item B<update_meta_instance_dependencies>
1263 Reregisters if necessary.
1265 =item B<add_dependent_meta_instance> $metaclass
1267 Registers the class as having a meta instance dependent on this class.
1269 =item B<remove_dependent_meta_instance> $metaclass
1271 Remove the class from the list of dependent classes.
1273 =item B<invalidate_meta_instances>
1275 Clears the cached meta instance for this metaclass and all of the registered
1276 classes with dependent meta instances.
1278 Called by C<add_attribute> and C<remove_attribute> to recalculate the attribute
1281 =item B<invalidate_meta_instance>
1283 Used by C<invalidate_meta_instances>.
1287 =head2 Object instance construction and cloning
1289 These methods are B<entirely optional>, it is up to you whether you want
1294 =item B<instance_metaclass>
1296 Returns the class name of the instance metaclass, see L<Class::MOP::Instance>
1297 for more information on the instance metaclasses.
1299 =item B<get_meta_instance>
1301 Returns an instance of L<Class::MOP::Instance> to be used in the construction
1302 of a new instance of the class.
1304 =item B<create_meta_instance>
1306 Called by C<get_meta_instance> if necessary.
1308 =item B<new_object (%params)>
1310 This is a convience method for creating a new object of the class, and
1311 blessing it into the appropriate package as well. Ideally your class
1312 would call a C<new> this method like so:
1315 my ($class, %param) = @_;
1316 $class->meta->new_object(%params);
1319 =item B<construct_instance (%params)>
1321 This method is used to construct an instance structure suitable for
1322 C<bless>-ing into your package of choice. It works in conjunction
1323 with the Attribute protocol to collect all applicable attributes.
1325 This will construct and instance using a HASH ref as storage
1326 (currently only HASH references are supported). This will collect all
1327 the applicable attributes and layout out the fields in the HASH ref,
1328 it will then initialize them using either use the corresponding key
1329 in C<%params> or any default value or initializer found in the
1330 attribute meta-object.
1332 =item B<clone_object ($instance, %params)>
1334 This is a convience method for cloning an object instance, then
1335 blessing it into the appropriate package. This method will call
1336 C<clone_instance>, which performs a shallow copy of the object,
1337 see that methods documentation for more details. Ideally your
1338 class would call a C<clone> this method like so:
1340 sub MyClass::clone {
1341 my ($self, %param) = @_;
1342 $self->meta->clone_object($self, %params);
1345 =item B<clone_instance($instance, %params)>
1347 This method is a compliment of C<construct_instance> (which means if
1348 you override C<construct_instance>, you need to override this one too),
1349 and clones the instance shallowly.
1351 The cloned structure returned is (like with C<construct_instance>) an
1352 unC<bless>ed HASH reference, it is your responsibility to then bless
1353 this cloned structure into the right class (which C<clone_object> will
1356 As of 0.11, this method will clone the C<$instance> structure shallowly,
1357 as opposed to the deep cloning implemented in prior versions. After much
1358 thought, research and discussion, I have decided that anything but basic
1359 shallow cloning is outside the scope of the meta-object protocol. I
1360 think Yuval "nothingmuch" Kogman put it best when he said that cloning
1361 is too I<context-specific> to be part of the MOP.
1363 =item B<rebless_instance($instance, ?%params)>
1365 This will change the class of C<$instance> to the class of the invoking
1366 C<Class::MOP::Class>. You may only rebless the instance to a subclass of
1367 itself. You may pass in optional C<%params> which are like constructor
1368 params and will override anything already defined in the instance.
1372 =head2 Informational
1374 These are a few predicate methods for asking information about the class.
1378 =item B<is_anon_class>
1380 This returns true if the class is a C<Class::MOP::Class> created anon class.
1384 This returns true if the class is still mutable.
1386 =item B<is_immutable>
1388 This returns true if the class has been made immutable.
1392 =head2 Inheritance Relationships
1396 =item B<superclasses (?@superclasses)>
1398 This is a read-write attribute which represents the superclass
1399 relationships of the class the B<Class::MOP::Class> instance is
1400 associated with. Basically, it can get and set the C<@ISA> for you.
1402 =item B<class_precedence_list>
1404 This computes the a list of all the class's ancestors in the same order
1405 in which method dispatch will be done. This is similair to what
1406 B<Class::ISA::super_path> does, but we don't remove duplicate names.
1408 =item B<linearized_isa>
1410 This returns a list based on C<class_precedence_list> but with all
1415 This returns a list of subclasses for this class.
1423 =item B<get_method_map>
1425 Returns a HASH ref of name to CODE reference mapping for this class.
1427 =item B<method_metaclass>
1429 Returns the class name of the method metaclass, see L<Class::MOP::Method>
1430 for more information on the method metaclasses.
1432 =item B<add_method ($method_name, $method)>
1434 This will take a C<$method_name> and CODE reference to that
1435 C<$method> and install it into the class's package.
1438 This does absolutely nothing special to C<$method>
1439 other than use B<Sub::Name> to make sure it is tagged with the
1440 correct name, and therefore show up correctly in stack traces and
1443 =item B<alias_method ($method_name, $method)>
1445 This will take a C<$method_name> and CODE reference to that
1446 C<$method> and alias the method into the class's package.
1449 Unlike C<add_method>, this will B<not> try to name the
1450 C<$method> using B<Sub::Name>, it only aliases the method in
1451 the class's package.
1453 =item B<has_method ($method_name)>
1455 This just provides a simple way to check if the class implements
1456 a specific C<$method_name>. It will I<not> however, attempt to check
1457 if the class inherits the method (use C<UNIVERSAL::can> for that).
1459 This will correctly handle functions defined outside of the package
1460 that use a fully qualified name (C<sub Package::name { ... }>).
1462 This will correctly handle functions renamed with B<Sub::Name> and
1463 installed using the symbol tables. However, if you are naming the
1464 subroutine outside of the package scope, you must use the fully
1465 qualified name, including the package name, for C<has_method> to
1466 correctly identify it.
1468 This will attempt to correctly ignore functions imported from other
1469 packages using B<Exporter>. It breaks down if the function imported
1470 is an C<__ANON__> sub (such as with C<use constant>), which very well
1471 may be a valid method being applied to the class.
1473 In short, this method cannot always be trusted to determine if the
1474 C<$method_name> is actually a method. However, it will DWIM about
1475 90% of the time, so it's a small trade off I think.
1477 =item B<get_method ($method_name)>
1479 This will return a Class::MOP::Method instance related to the specified
1480 C<$method_name>, or return undef if that method does not exist.
1482 The Class::MOP::Method is codifiable, so you can use it like a normal
1483 CODE reference, see L<Class::MOP::Method> for more information.
1485 =item B<find_method_by_name ($method_name)>
1487 This will return a CODE reference of the specified C<$method_name>,
1488 or return undef if that method does not exist.
1490 Unlike C<get_method> this will also look in the superclasses.
1492 =item B<remove_method ($method_name)>
1494 This will attempt to remove a given C<$method_name> from the class.
1495 It will return the CODE reference that it has removed, and will
1496 attempt to use B<Sub::Name> to clear the methods associated name.
1498 =item B<get_method_list>
1500 This will return a list of method names for all I<locally> defined
1501 methods. It does B<not> provide a list of all applicable methods,
1502 including any inherited ones. If you want a list of all applicable
1503 methods, use the C<compute_all_applicable_methods> method.
1505 =item B<get_all_methods>
1507 This will traverse the inheritance heirachy and return a list of all
1508 the applicable L<Class::MOP::Method> objects for this class.
1510 =item B<compute_all_applicable_methods>
1514 This method returns a list of hashes describing the all the methods of the
1517 Use L<get_all_methods>, which is easier/better/faster. This method predates
1518 L<Class::MOP::Method>.
1520 =item B<find_all_methods_by_name ($method_name)>
1522 This will traverse the inheritence hierarchy and locate all methods
1523 with a given C<$method_name>. Similar to
1524 C<compute_all_applicable_methods> it returns a list of HASH references
1525 with the following information; method name (which will always be the
1526 same as C<$method_name>), the name of the class in which the method
1527 lives and a CODE reference for the actual method.
1529 The list of methods produced is a distinct list, meaning there are no
1530 duplicates in it. This is especially useful for things like object
1531 initialization and destruction where you only want the method called
1532 once, and in the correct order.
1534 =item B<find_next_method_by_name ($method_name)>
1536 This will return the first method to match a given C<$method_name> in
1537 the superclasses, this is basically equivalent to calling
1538 C<SUPER::$method_name>, but it can be dispatched at runtime.
1542 =head2 Method Modifiers
1544 Method modifiers are a concept borrowed from CLOS, in which a method
1545 can be wrapped with I<before>, I<after> and I<around> method modifiers
1546 that will be called everytime the method is called.
1548 =head3 How method modifiers work?
1550 Method modifiers work by wrapping the original method and then replacing
1551 it in the classes symbol table. The wrappers will handle calling all the
1552 modifiers in the appropariate orders and preserving the calling context
1553 for the original method.
1555 Each method modifier serves a particular purpose, which may not be
1556 obvious to users of other method wrapping modules. To start with, the
1557 return values of I<before> and I<after> modifiers are ignored. This is
1558 because thier purpose is B<not> to filter the input and output of the
1559 primary method (this is done with an I<around> modifier). This may seem
1560 like an odd restriction to some, but doing this allows for simple code
1561 to be added at the begining or end of a method call without jeapordizing
1562 the normal functioning of the primary method or placing any extra
1563 responsibility on the code of the modifier. Of course if you have more
1564 complex needs, then use the I<around> modifier, which uses a variation
1565 of continutation passing style to allow for a high degree of flexibility.
1567 Before and around modifiers are called in last-defined-first-called order,
1568 while after modifiers are called in first-defined-first-called order. So
1569 the call tree might looks something like this:
1579 To see examples of using method modifiers, see the following examples
1580 included in the distribution; F<InstanceCountingClass>, F<Perl6Attribute>,
1581 F<AttributesWithHistory> and F<C3MethodDispatchOrder>. There is also a
1582 classic CLOS usage example in the test F<017_add_method_modifier.t>.
1584 =head3 What is the performance impact?
1586 Of course there is a performance cost associated with method modifiers,
1587 but we have made every effort to make that cost be directly proportional
1588 to the amount of modifier features you utilize.
1590 The wrapping method does it's best to B<only> do as much work as it
1591 absolutely needs to. In order to do this we have moved some of the
1592 performance costs to set-up time, where they are easier to amortize.
1594 All this said, my benchmarks have indicated the following:
1596 simple wrapper with no modifiers 100% slower
1597 simple wrapper with simple before modifier 400% slower
1598 simple wrapper with simple after modifier 450% slower
1599 simple wrapper with simple around modifier 500-550% slower
1600 simple wrapper with all 3 modifiers 1100% slower
1602 These numbers may seem daunting, but you must remember, every feature
1603 comes with some cost. To put things in perspective, just doing a simple
1604 C<AUTOLOAD> which does nothing but extract the name of the method called
1605 and return it costs about 400% over a normal method call.
1609 =item B<add_before_method_modifier ($method_name, $code)>
1611 This will wrap the method at C<$method_name> and the supplied C<$code>
1612 will be passed the C<@_> arguments, and called before the original
1613 method is called. As specified above, the return value of the I<before>
1614 method modifiers is ignored, and it's ability to modify C<@_> is
1615 fairly limited. If you need to do either of these things, use an
1616 C<around> method modifier.
1618 =item B<add_after_method_modifier ($method_name, $code)>
1620 This will wrap the method at C<$method_name> so that the original
1621 method will be called, it's return values stashed, and then the
1622 supplied C<$code> will be passed the C<@_> arguments, and called.
1623 As specified above, the return value of the I<after> method
1624 modifiers is ignored, and it cannot modify the return values of
1625 the original method. If you need to do either of these things, use an
1626 C<around> method modifier.
1628 =item B<add_around_method_modifier ($method_name, $code)>
1630 This will wrap the method at C<$method_name> so that C<$code>
1631 will be called and passed the original method as an extra argument
1632 at the begining of the C<@_> argument list. This is a variation of
1633 continuation passing style, where the function prepended to C<@_>
1634 can be considered a continuation. It is up to C<$code> if it calls
1635 the original method or not, there is no restriction on what the
1636 C<$code> can or cannot do.
1642 It should be noted that since there is no one consistent way to define
1643 the attributes of a class in Perl 5. These methods can only work with
1644 the information given, and can not easily discover information on
1645 their own. See L<Class::MOP::Attribute> for more details.
1649 =item B<attribute_metaclass>
1651 Returns the class name of the attribute metaclass, see L<Class::MOP::Attribute>
1652 for more information on the attribute metaclasses.
1654 =item B<get_attribute_map>
1656 This returns a HASH ref of name to attribute meta-object mapping.
1658 =item B<add_attribute ($attribute_meta_object | ($attribute_name, %attribute_spec))>
1660 This stores the C<$attribute_meta_object> (or creates one from the
1661 C<$attribute_name> and C<%attribute_spec>) in the B<Class::MOP::Class>
1662 instance associated with the given class. Unlike methods, attributes
1663 within the MOP are stored as meta-information only. They will be used
1664 later to construct instances from (see C<construct_instance> above).
1665 More details about the attribute meta-objects can be found in the
1666 L<Class::MOP::Attribute> or the L<Class::MOP/The Attribute protocol>
1669 It should be noted that any accessor, reader/writer or predicate
1670 methods which the C<$attribute_meta_object> has will be installed
1671 into the class at this time.
1674 If an attribute already exists for C<$attribute_name>, the old one
1675 will be removed (as well as removing all it's accessors), and then
1678 =item B<has_attribute ($attribute_name)>
1680 Checks to see if this class has an attribute by the name of
1681 C<$attribute_name> and returns a boolean.
1683 =item B<get_attribute ($attribute_name)>
1685 Returns the attribute meta-object associated with C<$attribute_name>,
1686 if none is found, it will return undef.
1688 =item B<remove_attribute ($attribute_name)>
1690 This will remove the attribute meta-object stored at
1691 C<$attribute_name>, then return the removed attribute meta-object.
1694 Removing an attribute will only affect future instances of
1695 the class, it will not make any attempt to remove the attribute from
1696 any existing instances of the class.
1698 It should be noted that any accessor, reader/writer or predicate
1699 methods which the attribute meta-object stored at C<$attribute_name>
1700 has will be removed from the class at this time. This B<will> make
1701 these attributes somewhat inaccessable in previously created
1702 instances. But if you are crazy enough to do this at runtime, then
1703 you are crazy enough to deal with something like this :).
1705 =item B<get_attribute_list>
1707 This returns a list of attribute names which are defined in the local
1708 class. If you want a list of all applicable attributes for a class,
1709 use the C<compute_all_applicable_attributes> method.
1711 =item B<compute_all_applicable_attributes>
1713 =item B<get_all_attributes>
1715 This will traverse the inheritance heirachy and return a list of all
1716 the applicable L<Class::MOP::Attribute> objects for this class.
1718 C<get_all_attributes> is an alias for consistency with C<get_all_methods>.
1720 =item B<find_attribute_by_name ($attr_name)>
1722 This method will traverse the inheritance heirachy and find the
1723 first attribute whose name matches C<$attr_name>, then return it.
1724 It will return undef if nothing is found.
1728 =head2 Class Immutability
1732 =item B<make_immutable (%options)>
1734 This method will invoke a tranforamtion upon the class which will
1735 make it immutable. Details of this transformation can be found in
1736 the L<Class::MOP::Immutable> documentation.
1738 =item B<make_mutable>
1740 This method will reverse tranforamtion upon the class which
1743 =item B<get_immutable_transformer>
1745 Return a transformer suitable for making this class immutable or, if this
1746 class is immutable, the transformer used to make it immutable.
1748 =item B<get_immutable_options>
1750 If the class is immutable, return the options used to make it immutable.
1752 =item B<create_immutable_transformer>
1754 Create a transformer suitable for making this class immutable
1760 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1762 =head1 COPYRIGHT AND LICENSE
1764 Copyright 2006-2008 by Infinity Interactive, Inc.
1766 L<http://www.iinteractive.com>
1768 This library is free software; you can redistribute it and/or modify
1769 it under the same terms as Perl itself.