Kavorka::Sub - a function that has been declared
Kavorka::Sub is a role which represents a function declared using Kavorka. Classes implementing this role are used to parse functions, and also to inject Perl code into them.
Instances of classes implementing this role are also returned by Kavorka's function introspection API.
A function instance has the following methods.
keyword
The keyword (e.g. method) used to declare the function.
method
package
Returns the package name the parameter was declared in. Not necessarily the package it will be installed into...
package Foo; fun UNIVERSAL::quux { ... } # will be installed into UNIVERSAL
declared_name
The declared name of the function (if any).
qualified_name
The name the function will be installed as, based on the package and declared name.
signature
An instance of Kavorka::Signature, or undef.
prototype
The function prototype as a string.
attributes
The function attributes. The structure returned by this method is subject to change.
body
The function body as a coderef. Note that this coderef will have had the signature code injected into it.
parse
parse_attributes
parse_prototype
parse_signature
Internal methods used to parse a signature. It only makes sense to use these within a Parse::Keyword parser.
signature_class
A class to use for signatures.
default_attributes
Returns a list of attributes to add to the sub when it is parsed. It would make sense to override this in classes implementing this role, however attributes don't currently work properly anyway.
The implementation defined in this role returns the empty list.
default_invocant
Returns a list invocant parameters to add to the signature if no invocants are specified in the signature. It makes sense to override this for keywords which have implicit invocants, such as method. (See Kavorka::Sub::Method for an example.)
forward_declare_sub
Method called at compile time to forward-declare the sub, if that behaviour is desired.
The implementation defined in this role does nothing, but Kavorka::Sub::Fun actually does some forward declaration.
install_sub
Method called at run time to install the sub into the symbol table.
This makes sense to override if the sub shouldn't be installed in the normal Perlish way. For example Kavorka::MethodModifier overrides it.
Please report any bugs to http://rt.cpan.org/Dist/Display.html?Queue=Kavorka.
http://perlcabal.org/syn/S06.html, Kavorka, Kavorka::Signature::Parameter.
Toby Inkster <tobyink@cpan.org>.
This software is copyright (c) 2013 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
To install Kavorka, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Kavorka
CPAN shell
perl -MCPAN -e shell install Kavorka
For more information on module installation, please visit the detailed CPAN module installation guide.