From: Dave Rolsky Date: Mon, 16 Mar 2009 04:38:38 +0000 (-0500) Subject: major revamp of CMOP::Class docs X-Git-Tag: 0.78_01~29 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c02d53a4eaeaabc57d2f37fa16e9eae72d10d943;p=gitmo%2FClass-MOP.git major revamp of CMOP::Class docs --- diff --git a/lib/Class/MOP/Class.pm b/lib/Class/MOP/Class.pm index 4b0fa32..5e50e76 100644 --- a/lib/Class/MOP/Class.pm +++ b/lib/Class/MOP/Class.pm @@ -1133,254 +1133,181 @@ Class::MOP::Class - Class Meta Object =head1 DESCRIPTION -This is the largest and currently most complex part of the Perl 5 -meta-object protocol. It controls the introspection and -manipulation of Perl 5 classes (and it can create them too). The -best way to understand what this module can do, is to read the -documentation for each of it's methods. +This is the largest and most complex part of the Class::MOP +meta-object protocol. It controls the introspection and manipulation +of Perl 5 classes, and it can create them as wlel. The best way to +understand what this module can do, is to read the documentation for +each of its methods. =head1 INHERITANCE -B is a subclass of L +C is a subclass of L. =head1 METHODS -=head2 Self Introspection - -=over 4 - -=item B - -This will return a B instance which is related -to this class. Thereby allowing B to actually -introspect itself. - -As with B, B will actually -bootstrap this module by installing a number of attribute meta-objects -into it's metaclass. This will allow this class to reap all the benifits -of the MOP when subclassing it. - -=back - =head2 Class construction -These methods will handle creating B objects, -which can be used to both create new classes, and analyze -pre-existing classes. +These methods all create new C objects. These +objects can represent existing classes, or they can be used to create +new classes from scratch. -This module will internally store references to all the instances -you create with these methods, so that they do not need to be -created any more than nessecary. Basically, they are singletons. +The metaclass object for a given class is a singleton. If you attempt +to create a metaclass for the same class twice, you will just get the +existing object. =over 4 -=item B ?$version, - authority =E ?$authority, - superclasses =E ?@superclasses, - methods =E ?%methods, - attributes =E ?%attributes)> - -This returns a B object, bringing the specified -C<$package_name> into existence and adding any of the C<$version>, -C<$authority>, C<@superclasses>, C<%methods> and C<%attributes> to -it. - -=item B ?@superclasses, - methods =E ?%methods, - attributes =E ?%attributes)> - -This will create an anonymous class, it works much like C but -it does not need a C<$package_name>. Instead it will create a suitably -unique package name for you to stash things into. - -On very important distinction is that anon classes are destroyed once -the metaclass they are attached to goes out of scope. In the DESTROY -method, the created package will be removed from the symbol table. +=item B<< Class::MOP::Class->create($package_name, %options) >> -It is also worth noting that any instances created with an anon-class -will keep a special reference to the anon-meta which will prevent the -anon-class from going out of scope until all instances of it have also -been destroyed. This however only works for HASH based instance types, -as we use a special reserved slot (C<__MOP__>) to store this. +This method creates a new C object with the given +package name. It accepts a number of options. -=item B +=over 8 -This initializes and returns returns a B object for -a given a C<$package_name>. If a metaclass already exists for the -package, it simply returns it instead of creating a new one. +=item * version -=item B +An optional version number for the newly created package. -This will construct an instance of B, it is -here so that we can actually "tie the knot" for B -to use C once all the bootstrapping is done. This -method is used internally by C and should never be called -from outside of that method really. +=item * authority -=item B +An optional authority for the newly created package. -This method is called as the very last thing in the -C method. This will check that the -metaclass you are creating is compatible with the metaclasses of all -your ancestors. For more inforamtion about metaclass compatibility -see the C section in L. +=item * superclasses -=item B +An optional array reference of superclass names. -This will reset the package cache flag for this particular metaclass -it is basically the value of the C -function. This is very rarely needed from outside of C -but in some cases you might want to use it, so it is here. +=item * methods -=item B +An optional hash reference of methods for the class. The keys of the +hash reference are method names, and values are subroutine references. -Clears the package cache flag to announce to the internals that we need -to rebuild the method map. +=item * attributes -=item B +An optional array reference of attributes. -Registers this class as dependent on its superclasses. +An attribute can be passed as an existing L +object, I or as a hash reference of options which will be passed +to the attribute metaclass's constructor. -Only superclasses from which this class inherits attributes will be added. - -=item B +=back -Unregisters this class from its superclasses. +=item B<< Class::MOP::Class->create_anon_class(%options) >> -=item B +This method works just like C<< Class::MOP::Class->create >> but it +creates an "anonymous" class. In fact, the class does have a name, but +that name is a unique name generated internally by this module. -Reregisters if necessary. +It accepts the same C, C, and C +parameters that C accepts. -=item B $metaclass +Anonymous classes are destroyed once the metaclass they are attached +to goes out of scope, and will be removed from Perl's internal symbol +table. -Registers the class as having a meta instance dependent on this class. +All instances of an anonymous class keep a special reference to the +metaclass object, which prevents the metaclass from going out of scope +while any instances exist. -=item B $metaclass +This only works if the instance if based on a hash reference, however. -Remove the class from the list of dependent classes. +=item B<< Class::MOP::Class->initialize($package_name, %options) >> -=item B +This method will initialize a C object for the +named package. Unlike C, this method I create a new +class. -Clears the cached meta instance for this metaclass and all of the registered -classes with dependent meta instances. +The purpose of this method is to retrieve a C +object for introspecting an existing class. -Called by C and C to recalculate the attribute -slots. +If an existing C object exists for the named +package, it will be returned, and any options provided will be +ignored! -=item B +If the object does not yet exist, it will be created. -Used by C. +The valid options that can be passed to this method are +C, C, +C, and C. These are all +optional, and default to the appropriate class in the C +distribution. =back =head2 Object instance construction and cloning -These methods are B, it is up to you whether you want -to use them or not. +These methods are all related to creating and/or cloning object +instances. =over 4 -=item B - -Returns the class name of the instance metaclass, see L -for more information on the instance metaclasses. - -=item B - -Returns an instance of L to be used in the construction -of a new instance of the class. +=item B<< $metaclass->clone_object($instance, %params) >> -=item B +This method clones an existing object instance. Any parameters you +provide are will override existing attribute values in the object. -Called by C if necessary. - -=item B +This is a convience method for cloning an object instance, then +blessing it into the appropriate package. -This is a convience method for creating a new object of the class, and -blessing it into the appropriate package as well. Ideally your class -would call a C this method like so: +You could implement a clone method in your class, using this method: - sub MyClass::new { - my ($class, %param) = @_; - $class->meta->new_object(%params); + sub clone { + my ($self, %params) = @_; + $self->meta->clone_object($self, %params); } -=item B +=item B<< $metaclass->rebless_instance($instance, %params) >> -This method is used to construct an instance structure suitable for -C-ing into your package of choice. It works in conjunction -with the Attribute protocol to collect all applicable attributes. +This method changes the class of C<$instance> to the metaclass's class. -This will construct an instance using a HASH ref as storage -(currently only HASH references are supported). This will collect all -the applicable attributes and layout out the fields in the HASH ref, -it will then initialize them using either use the corresponding key -in C<%params> or any default value or initializer found in the -attribute meta-object. +You can only rebless an instance into a subclass of its current +class. If you pass any additional parameters, these will be treated +like constructor parameters and used to initialize the object's +attributes. Any existing attributes that are already set will be +overwritten. -=item B +=item B<< $metaclass->new_object(%params) > -This is a convience method for cloning an object instance, then -blessing it into the appropriate package. This method will call -C, which performs a shallow copy of the object, -see that methods documentation for more details. Ideally your -class would call a C this method like so: +This method is used to create a new object of the metaclass's +class. Any parameters you provide are used to initialize the +instance's attributes. - sub MyClass::clone { - my ($self, %param) = @_; - $self->meta->clone_object($self, %params); - } +=item B<< $metaclass->instance_metaclass >> -=item B +Returns the class name of the instance metaclass, see +L for more information on the instance +metaclasses. -This method is a compliment of C (which means if -you override C, you need to override this one too), -and clones the instance shallowly. +=item B<< $metaclass->get_meta_instance >> -The cloned structure returned is (like with C) an -unCed HASH reference, it is your responsibility to then bless -this cloned structure into the right class (which C will -do for you). - -As of 0.11, this method will clone the C<$instance> structure shallowly, -as opposed to the deep cloning implemented in prior versions. After much -thought, research and discussion, I have decided that anything but basic -shallow cloning is outside the scope of the meta-object protocol. I -think Yuval "nothingmuch" Kogman put it best when he said that cloning -is too I to be part of the MOP. - -=item B - -This will change the class of C<$instance> to the class of the invoking -C. You may only rebless the instance to a subclass of -itself. You may pass in optional C<%params> which are like constructor -params and will override anything already defined in the instance. +Returns an instance of the C to be used in the +construction of a new instance of the class. =back -=head2 Informational +=head2 Informational predicates -These are a few predicate methods for asking information about the class. +These are a few predicate methods for asking information about the +class itself. =over 4 -=item B +=item B<< $metaclass->is_anon_class >> -This returns true if the class is a C created anon class. +This returns true if the class was created by calling C<< +Class::MOP::Class->create_anon_class >>. -=item B +=item B<< $metaclass->is_mutable >> This returns true if the class is still mutable. -=item B +=item B<< $metaclass->is_immutable >> This returns true if the class has been made immutable. -=item B +=item B<< $metaclass->is_pristine >> -Checks whether the class has any data that will be lost if C is -called. +A class is I pristine if it has non-inherited attributes or if it +has any generated methods. =back @@ -1388,384 +1315,332 @@ called. =over 4 -=item B +=item B<< $metaclass->superclasses(@superclasses) >> -This is a read-write attribute which represents the superclass -relationships of the class the B instance is -associated with. Basically, it can get and set the C<@ISA> for you. +This is a read-write accessor which represents the superclass +relationships of the metaclass's class. -=item B +This is basically sugar around getting and setting C<@ISA>. -This computes the a list of all the class's ancestors in the same order -in which method dispatch will be done. This is similair to what -B does, but we don't remove duplicate names. +=item B<< $metaclass->class_precedence_list >> -=item B +This returns a list of all of the class's ancestor classes. The +classes are returned in method dispatch order. -This returns a list based on C but with all +=item B<< $metaclass->linearized_isa >> + +This returns a list based on C but with all duplicates removed. -=item B +=item B<< $metaclass->subclasses >> -This returns a list of subclasses for this class. +This returns a list of subclasses for this class. =back -=head2 Methods - -=over 4 - -=item B +=head2 Method introspection and creation -Returns a HASH ref of name to L instance mapping -for this class. +These methods allow you to introspect a class's methods, as well as +add, remove, or change methods. -=item B +Determining what is truly a method in a Perl 5 class requires some +heuristics (aka guessing). -Returns the class name of the method metaclass, see L -for more information on the method metaclasses. +Methods defined outside the package with a fully qualified name (C) will be included. Similarly, methods named +with a fully qualified name using L are also included. -=item B +However, we attempt to ignore imported functions. -Wrap a code ref (C<$attrs{body>) with C. +Ultimately, we are using heuristics to determine what truly is a +method in a class, and these heuristics may get the wrong answer in +some edge cases. However, for most "normal" cases the heuristics work +correctly. -=item B +=over 4 -This will take a C<$method_name> and CODE reference or meta method -objectand install it into the class's package. +=item B<< $metaclass->get_method($method_name) >> -You are strongly encouraged to pass a meta method object instead of a -code reference. If you do so, that object gets stored as part of the -class's method map, providing more useful information about the method -for introspection. +This will return a L for the specified +C<$method_name>. If the class does not have the specified method, it +returns C -When you provide a method object, this method will clone that object -if the object's package name does not match the class name. This lets -us track the original source of any methods added from other classes -(notably Moose roles). +=item B<< $metaclass->has_method($method_name) >> -B: -This does absolutely nothing special to C<$method> -other than use B to make sure it is tagged with the -correct name, and therefore show up correctly in stack traces and -such. +Returns a boolean indicating whether or not the class defines the +named method. It does not include methods inherited from parent +classes. -=item B +=item B<< $metaclass->get_method_map >> -This just provides a simple way to check if the class implements -a specific C<$method_name>. It will I however, attempt to check -if the class inherits the method (use C for that). +Returns a hash reference representing the methods defined in this +class. The keys are method names and the values are +L objects. -This will correctly handle functions defined outside of the package -that use a fully qualified name (C). +=item B<< $metaclass->get_method_list >> -This will correctly handle functions renamed with B and -installed using the symbol tables. However, if you are naming the -subroutine outside of the package scope, you must use the fully -qualified name, including the package name, for C to -correctly identify it. +This will return a list of method I for all methods defined in +this class. -This will attempt to correctly ignore functions imported from other -packages using B. It breaks down if the function imported -is an C<__ANON__> sub (such as with C), which very well -may be a valid method being applied to the class. +=item B<< $metaclass->get_all_methods >> -In short, this method cannot always be trusted to determine if the -C<$method_name> is actually a method. However, it will DWIM about -90% of the time, so it's a small trade off I think. +This will traverse the inheritance hierarchy and return a list of all +the L objects for this class and its parents. -=item B +=item B<< $metaclass->find_method_by_name($method_name) >> -This will return a Class::MOP::Method instance related to the specified -C<$method_name>, or return undef if that method does not exist. +This will return a L for the specified +C<$method_name>. If the class does not have the specified method, it +returns C -The Class::MOP::Method is codifiable, so you can use it like a normal -CODE reference, see L for more information. +Unlike C, this method I look for the named method in +superclasses. -=item B +=item B<< $metaclass->get_all_method_names >> -This will return a L instance for the specified -C<$method_name>, or return undef if that method does not exist. +This will return a list of method I for all of this class's +methods, including inherited methods. -Unlike C this will also look in the superclasses. +=item B<< $metaclass->find_all_methods_by_name($method_name) >> -=item B +This method looks for the named method in the class and all of its +parents. It returns every matching method it finds in the inheritance +tree, so it returns a list of methods. -This will attempt to remove a given C<$method_name> from the class. -It will return the L instance that it has removed, -and will attempt to use B to clear the methods associated -name. +Each method is returned as a hash reference with three keys. The keys +are C, C, and C. The C key has a +L object as its value. -=item B +The list of methods is distinct. -This will return a list of method names for all I defined -methods. It does B provide a list of all applicable methods, -including any inherited ones. If you want a list of all applicable -methods, use the C method. +=item B<< $metaclass->find_next_method_by_name($method_name) >> -=item B +This method returns the first method in any superclass matching the +given name. It is effectively the method that C +would dispatch to. -This will traverse the inheritance hierarchy and return a list of all -the applicable L objects for this class. +=back -=item B +=head2 Attribute introspection and creation -Deprecated. +Because Perl 5 does not have a core concept of attributes in classes, +we can only return information about attributes which have been added +via this class's methods. We cannot discover information about +attributes which are defined in terms of "regular" Perl 5 methods. -This method returns a list of hashes describing the all the methods of the -class. - -Use L, which is easier/better/faster. This method predates -L. +=over 4 -=item B +=item B<< $metaclass->get_attribute($attribute_name) >> -This will traverse the inheritance hierarchy and return a list of all the -applicable method names for this class. Duplicate names are removed, but the -order the methods come out is not defined. +This will return a L for the specified +C<$attribute_name>. If the class does not have the specified +attribute, it returns C -=item B +=item B<< $metaclass->has_attribute($attribute_name) >> -This will traverse the inheritence hierarchy and locate all methods -with a given C<$method_name>. Similar to -C it returns a list of HASH references -with the following information; method name (which will always be the -same as C<$method_name>), the name of the class in which the method -lives and a CODE reference for the actual method. +Returns a boolean indicating whether or not the class defines the +named attribute. It does not include attributes inherited from parent +classes. -The list of methods produced is a distinct list, meaning there are no -duplicates in it. This is especially useful for things like object -initialization and destruction where you only want the method called -once, and in the correct order. +=item B<< $metaclass->get_attribute_map >> -=item B +Returns a hash reference representing the attributes defined in this +class. The keys are attribute names and the values are +L objects. -This will return the first method to match a given C<$method_name> in -the superclasses, this is basically equivalent to calling -C, but it can be dispatched at runtime. +=item B<< $metaclass->get_attribute_list >> -=item B +This will return a list of attributes I for all attributes +defined in this class. -B: This method is now deprecated. Just use C -instead. +=item B<< $metaclass->get_all_attributes >> -=back +This will traverse the inheritance hierarchy and return a list of all +the L objects for this class and its parents. -=head2 Method Modifiers +This method can also be called as C. -Method modifiers are a concept borrowed from CLOS, in which a method -can be wrapped with I, I and I method modifiers -that will be called everytime the method is called. +=item B<< $metaclass->find_attribute_by_name($attribute_name) >> -=head3 How method modifiers work? +This will return a L for the specified +C<$attribute_name>. If the class does not have the specified +attribute, it returns C -Method modifiers work by wrapping the original method and then replacing -it in the classes symbol table. The wrappers will handle calling all the -modifiers in the appropariate orders and preserving the calling context -for the original method. - -Each method modifier serves a particular purpose, which may not be -obvious to users of other method wrapping modules. To start with, the -return values of I and I modifiers are ignored. This is -because thier purpose is B to filter the input and output of the -primary method (this is done with an I modifier). This may seem -like an odd restriction to some, but doing this allows for simple code -to be added at the begining or end of a method call without jeapordizing -the normal functioning of the primary method or placing any extra -responsibility on the code of the modifier. Of course if you have more -complex needs, then use the I modifier, which uses a variation -of continutation passing style to allow for a high degree of flexibility. - -Before and around modifiers are called in last-defined-first-called order, -while after modifiers are called in first-defined-first-called order. So -the call tree might looks something like this: +Unlike C, this attribute I look for the named +attribute in superclasses. - before 2 - before 1 - around 2 - around 1 - primary - around 1 - around 2 - after 1 - after 2 +=item B<< $metaclass->add_attribute(...) >> -To see examples of using method modifiers, see the following examples -included in the distribution; F, F, -F and F. There is also a -classic CLOS usage example in the test F<017_add_method_modifier.t>. +This method accepts either an existing L +object, or parameters suitable for passing to that class's C +method. -=head3 What is the performance impact? +The attribute provided will be added to the class. -Of course there is a performance cost associated with method modifiers, -but we have made every effort to make that cost be directly proportional -to the amount of modifier features you utilize. +Any accessor methods defined by the attribute will be added to the +class when the attribute is added. -The wrapping method does it's best to B do as much work as it -absolutely needs to. In order to do this we have moved some of the -performance costs to set-up time, where they are easier to amortize. +If an attribute of the same name already exists, the old attribute +will be removed first. -All this said, my benchmarks have indicated the following: +=item B<< $metaclass->remove_attribute($attribute_name) >> - simple wrapper with no modifiers 100% slower - simple wrapper with simple before modifier 400% slower - simple wrapper with simple after modifier 450% slower - simple wrapper with simple around modifier 500-550% slower - simple wrapper with all 3 modifiers 1100% slower +This will remove the named attribute from the class, and +L object. -These numbers may seem daunting, but you must remember, every feature -comes with some cost. To put things in perspective, just doing a simple -C which does nothing but extract the name of the method called -and return it costs about 400% over a normal method call. +Removing an attribute also removes any accessor methods defined by the +attribute. -=over 4 +However, note that removing an attribute will only affect I +object instances created for this class, not existing instances. -=item B +=item B<< $metaclass->attribute_metaclass >> -This will wrap the method at C<$method_name> and the supplied C<$code> -will be passed the C<@_> arguments, and called before the original -method is called. As specified above, the return value of the I -method modifiers is ignored, and it's ability to modify C<@_> is -fairly limited. If you need to do either of these things, use an -C method modifier. +Returns the class name of the attribute metaclass for this class. By +default, this is L. for more information on -=item B +=back -This will wrap the method at C<$method_name> so that the original -method will be called, it's return values stashed, and then the -supplied C<$code> will be passed the C<@_> arguments, and called. -As specified above, the return value of the I method -modifiers is ignored, and it cannot modify the return values of -the original method. If you need to do either of these things, use an -C method modifier. +=head2 Class Immutability -=item B +Making a class immutable "freezes" the class definition. You can no +longer call methods which alter the class, such as adding or removing +methods or attributes. -This will wrap the method at C<$method_name> so that C<$code> -will be called and passed the original method as an extra argument -at the begining of the C<@_> argument list. This is a variation of -continuation passing style, where the function prepended to C<@_> -can be considered a continuation. It is up to C<$code> if it calls -the original method or not, there is no restriction on what the -C<$code> can or cannot do. +Making a class immutable lets us optimize the class by inlning some +methods, and also allows us to optimize some methods on the metaclass +object itself. -=back +The immutabilization system in L takes much greater advantage +of the inlining features than Class::MOP itself does. -=head2 Attributes +=over 4 -It should be noted that since there is no one consistent way to define -the attributes of a class in Perl 5. These methods can only work with -the information given, and can not easily discover information on -their own. See L for more details. +=item B<< $metaclass->make_immutable(%options) >> -=over 4 +This method will create an immutable transformer and uses it to make +the class and its metaclass object immutable. -=item B +Details of how immutabilization works are in L +documentation. -Returns the class name of the attribute metaclass, see L -for more information on the attribute metaclasses. +=item B<< $metaclass->make_mutable >> -=item B +Calling this method reverse the immutabilization transformation. -This returns a HASH ref of name to attribute meta-object mapping. +=item B<< $metaclass->get_immutable_transformer >> -=item B +If the class has been made immutable previously, this returns the +L object that was created to do the +transformation. -This stores the C<$attribute_meta_object> (or creates one from the -C<$attribute_name> and C<%attribute_spec>) in the B -instance associated with the given class. Unlike methods, attributes -within the MOP are stored as meta-information only. They will be used -later to construct instances from (see C above). -More details about the attribute meta-objects can be found in the -L or the L -section. +If the class was never made immutable, this method will die. -It should be noted that any accessor, reader/writer or predicate -methods which the C<$attribute_meta_object> has will be installed -into the class at this time. +=back -B -If an attribute already exists for C<$attribute_name>, the old one -will be removed (as well as removing all it's accessors), and then -the new one added. +=head2 Method Modifiers -=item B +Method modifiers are hooks which allow a method to be wrapped with +I, I and I method modifiers. Every time a +method is called, it's modifiers are also called. -Checks to see if this class has an attribute by the name of -C<$attribute_name> and returns a boolean. +A class can modify its own methods, as well as methods defined in +parent classes. -=item B +=head3 How method modifiers work? -Returns the attribute meta-object associated with C<$attribute_name>, -if none is found, it will return undef. +Method modifiers work by wrapping the original method and then +replacing it in the class's symbol table. The wrappers will handle +calling all the modifiers in the appropariate orders and preserving +the calling context for the original method. -=item B +The return values of C and C modifiers are +ignored. This is because their purpose is B to filter the input +and output of the primary method (this is done with an I +modifier). -This will remove the attribute meta-object stored at -C<$attribute_name>, then return the removed attribute meta-object. +This may seem like an odd restriction to some, but doing this allows +for simple code to be added at the beginning or end of a method call +without altering the function of the wrapped method or placing any +extra responsibility on the code of the modifier. -B -Removing an attribute will only affect future instances of -the class, it will not make any attempt to remove the attribute from -any existing instances of the class. +Of course if you have more complex needs, you can use the C +modifier which allows you to change both the parameters passed to the +wrapped method, as well as its return value. -It should be noted that any accessor, reader/writer or predicate -methods which the attribute meta-object stored at C<$attribute_name> -has will be removed from the class at this time. This B make -these attributes somewhat inaccessable in previously created -instances. But if you are crazy enough to do this at runtime, then -you are crazy enough to deal with something like this :). +Before and around modifiers are called in last-defined-first-called +order, while after modifiers are called in first-defined-first-called +order. So the call tree might looks something like this: -=item B + before 2 + before 1 + around 2 + around 1 + primary + around 1 + around 2 + after 1 + after 2 -This returns a list of attribute names which are defined in the local -class. If you want a list of all applicable attributes for a class, -use the C method. +=head3 What is the performance impact? -=item B +Of course there is a performance cost associated with method +modifiers, but we have made every effort to make that cost directly +proportional to the number of modifier features you utilize. -=item B +The wrapping method does it's best to B do as much work as it +absolutely needs to. In order to do this we have moved some of the +performance costs to set-up time, where they are easier to amortize. -This will traverse the inheritance hierarchy and return a list of all -the applicable L objects for this class. +All this said, our benchmarks have indicated the following: -C is an alias for consistency with C. + simple wrapper with no modifiers 100% slower + simple wrapper with simple before modifier 400% slower + simple wrapper with simple after modifier 450% slower + simple wrapper with simple around modifier 500-550% slower + simple wrapper with all 3 modifiers 1100% slower -=item B +These numbers may seem daunting, but you must remember, every feature +comes with some cost. To put things in perspective, just doing a +simple C which does nothing but extract the name of the +method called and return it costs about 400% over a normal method +call. -This method will traverse the inheritance hierarchy and find the -first attribute whose name matches C<$attr_name>, then return it. -It will return undef if nothing is found. +=over 4 -=back +=item B<< $metaclass->add_before_method_modifier($method_name, $code) >> -=head2 Class Immutability +This wraps the specified method with the supplied subroutine +reference. The modifier will be called as a method itself, and will +receive the same arguments as are passed to the method. -=over 4 +When the modifier exits, the wrapped method will be called. -=item B +The return value of the modifier will be ignored. -This method will invoke a tranforamtion upon the class which will -make it immutable. Details of this transformation can be found in -the L documentation. +=item B<< $metaclass->add_after_method_modifier($method_name, $code) >> -=item B +This wraps the specified method with the supplied subroutine +reference. The modifier will be called as a method itself, and will +receive the same arguments as are passed to the method. -This method will reverse tranforamtion upon the class which -made it immutable. +When the wrapped methods exits, the modifier will be called. -=item B +The return value of the modifier will be ignored. -Return a transformer suitable for making this class immutable or, if this -class is immutable, the transformer used to make it immutable. +=item B<< $metaclass->add_around_method_modifier($method_name, $code) >> -=item B +This wraps the specified method with the supplied subroutine +reference. -If the class is immutable, return the options used to make it immutable. +The first argument passed to the modifier will be a subroutine +reference to the wrapped method. The second argument is the object, +and after that come any arguments passed when the method is called. -=item B +The around modifier can choose to call the original method, as well as +what arguments to pass if it does so. -Create a transformer suitable for making this class immutable +The return value of the modifier is what will be seen by the caller. =back diff --git a/xt/pod_coverage.t b/xt/pod_coverage.t index e6858d0..0b628b4 100644 --- a/xt/pod_coverage.t +++ b/xt/pod_coverage.t @@ -15,6 +15,29 @@ plan tests => scalar @modules; my %trustme = ( 'Class::MOP::Attribute' => ['process_accessors'], + 'Class::MOP::Class' => [ + # deprecated + 'alias_method', + 'compute_all_applicable_methods', + + # unfinished feature + 'add_dependent_meta_instance', + 'add_meta_instance_dependencies', + 'invalidate_meta_instance', + 'invalidate_meta_instances', + 'remove_dependent_meta_instance', + 'remove_meta_instance_depdendencies', + 'update_meta_instance_dependencies', + + # effectively internal + 'check_metaclass_compatibility', + 'clone_instance', + 'construct_class_instance', + 'construct_instance', + 'create_meta_instance', + 'reset_package_cache_flag', + 'update_package_cache_flag', + ], ); for my $module ( sort @modules ) {