Attribute-Storage-0.09000755001750001750 012334162322 13526 5ustar00leoleo000000000000Attribute-Storage-0.09/Changes000444001750001750 234112334162322 15156 0ustar00leoleo000000000000Revision history for Attribute-Storage 0.09 2014/05/12 16:06:20 [CHANGES] * Added apply_subattrs and find_subs_with_attr; useful copies from Circle code 0.08 BUGFIXES: * Ensure that dynamic late application using attributes->import works, even from other packages * Ensure that multi-line attribute definitions work 0.07 CHANGES: * Implement NAME attribute flag; allows attribute handling functions to know the name of the function they are being applied to 0.06 CHANGES: * Implement MULTI attribute flag; allows attributes to be invoked multiple times per marked sub 0.05 CHANGES: * Use XSLoader instead of DynaLoader 0.04 BUGFIXES: * Need to use Module::Build to build it now, generate a 'small' Makefile.PL rather than 'traditional' 0.03 CHANGES: * Use Magic to implement value storage behind CVs so that destruction correctly frees old values on code reload or dropping anonymous subs 0.02 CHANGES: * Allow RAWDATA for unparsed attributes * Various updates to keep CPANTS happy 0.01 First version, released on an unsuspecting world. Attribute-Storage-0.09/META.json000444001750001750 213312334162322 15303 0ustar00leoleo000000000000{ "abstract" : "declare and retrieve named attributes about CODE", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4205", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Attribute-Storage", "prereqs" : { "build" : { "requires" : { "ExtUtils::CBuilder" : "0", "Test::More" : "0.88", "Test::NoWarnings" : "0" } }, "configure" : { "requires" : { "Module::Build" : "0", "Module::Build::Compat" : "0" } }, "runtime" : { "requires" : { "XSLoader" : "0" } } }, "provides" : { "Attribute::Storage" : { "file" : "lib/Attribute/Storage.pm", "version" : "0.09" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.09" } Attribute-Storage-0.09/README000444001750001750 2206012334162322 14563 0ustar00leoleo000000000000NAME `Attribute::Storage' - declare and retrieve named attributes about CODE references SYNOPSIS package My::Package; use Attribute::Storage; sub Title :ATTR(CODE) { my $package = shift; my ( $title ) = @_; return $title; } package main; use Attribute::Storage qw( get_subattr ); use My::Package; sub myfunc :Title('The title of my function') { ... } print "Title of myfunc is: ".get_subattr(\&myfunc, 'Title')."\n"; DESCRIPTION This package provides a base, where a package using it can define handlers for particular code attributes. Other packages, using the package that defines the code attributes, can then use them to annotate subs. This is similar to `Attribute::Handlers', with the following key differences: * `Attribute::Storage' will store the value returned by the attribute handling code, and provides convenient lookup functions to retrieve it later. `Attribute::Handlers' simply invokes the handling code. * `Attribute::Storage' immediately executes the attribute handling code at compile-time. `Attribute::Handlers' defers invocation so it can look up the symbolic name of the sub the attribute is attached to. `Attribute::Storage' uses B to provide the name of the sub at invocation time, using the name of the underlying `GV'. * `Attribute::Storage' works just as well on anonymous subs as named ones. * `Attribute::Storage' is safe to use on code that will be reloaded, because it executes handlers immediately. `Attribute::Handlers' will only execute handlers at defined phases such as `BEGIN' or `INIT', and cannot reexecute the handlers in a file once it has been reloaded. ATTRIBUTES Each attribute that the defining package wants to define should be done using a marked subroutine, in a way similar to Attribute::Handlers. When a sub in the using package is marked with such an attribute, the code is executed, passing in the arguments. Whatever it returns is stored, to be returned later when queried by `get_subattr' or `get_subattrs'. The return value must be defined, or else the attribute will be marked as a compile error for perl to handle accordingly. Only `CODE' attributes are supported at present. sub AttributeName :ATTR(CODE) { my $package = shift; my ( $attr, $args, $here ) = @_; ... return $value; } At attachment time, the optional string that may appear within brackets following the attribute's name is parsed as a Perl expression in list context. If this succeeds, the values are passed as a list to the handling code. If this fails, an error is returned to the perl compiler. If no string is present, then an empty list is passed to the handling code. package Defining; sub NameMap :ATTR(CODE) { my $package = shift; my @strings = @_; return { map { m/^(.*)=(.*)$/ and ( $1, $2 ) } @strings }; } package Using; use Defining; sub somefunc :NameMap("foo=FOO","bar=BAR","splot=WIBBLE") { ... } my $map = get_subattr("somefunc", "NameMap"); # Will yield: # { foo => "FOO", # bar => "BAR", # splot => "WIBBLE" } Note that it is impossible to distinguish sub somefunc :NameMap { ... } sub somefunc :NameMap() { ... } It is possible to create attributes that do not parse their argument as a perl list expression, instead they just pass the plain string as a single argument. For this, add the `RAWDATA' flag to the `ATTR()' list. sub Title :ATTR(CODE,RAWDATA) { my $package = shift; my ( $text ) = @_; return $text; } sub thingy :Title(Here is the title for thingy) { ... } To obtain the name of the function to which the attribute is being applied, use the `NAME' flag to the `ATTR()' list. sub Callable :ATTR(CODE,NAME) { my $package = shift; my ( $subname, @args ) = @_; print "The Callable attribute is being applied to $package :: $subname\n"; return; } When applied to an anonymous function (`sub { ... }'), the name will appear as `__ANON__'. Normally it is an error to attempt to apply the same attribute more than once to the same function. Sometimes however, it would make sense for an attribute to be applied many times. If the `ATTR()' list is given the `MULTI' flag, then applying it more than once will be allowed. Each invocation of the handling code will be given the previous value that was returned, or `undef' for the first time. It is up to the code to perform whatever merging logic is required. sub Description :ATTR(CODE,MULTI,RAWDATA) { my $package = shift; my ( $olddesc, $more ) = @_; return defined $olddesc ? "$olddesc$more\n" : "$more\n"; } sub Argument :ATTR(CODE,MULTI) { my $package = shift; my ( $args, $argname ) = @_; push @$args, $argname; return $args; } sub Option :ATTR(CODE,MULTI) { my $package = shift; my ( $opts, $optname ) = @_; $opts and exists $opts->{$optname} and croak "Already have the $optname option"; $opts->{$optname}++; return $opts; } ... sub do_copy :Description(Copy from SOURCE to DESTINATION) :Description(Optionally preserves attributes) :Argument("SOURCE") :Argument("DESTINATION") :Option("attrs") :Option("verbose") { ... } FUNCTIONS $attrs = get_subattrs( $sub ) Returns a HASH reference containing all the attributes defined on the given sub. The sub should either be passed as a CODE reference, or as a name in the caller's package. If no attributes are defined, a reference to an empty HASH is returned. The returned HASH reference is a new shallow clone, the caller may modify this hash arbitrarily without breaking the stored data, or other users of it. $value = get_subattr( $sub, $attrname ) Returns the value of a single named attribute on the given sub. The sub should either be passed as a CODE reference, or as a name in the caller's package. If the attribute is not defined, `undef' is returned. $sub = apply_subattrs( @attrs_kvlist, $sub ) A utility function to help apply attributes dynamically to the given CODE reference. The CODE reference is given last so that calls to the function appear similar in visual style to the same applied at compiletime. apply_subattrs Title => "Here is my title", sub { return $title }; Is equivalent to sub :Title(Here is my title) { return $title } except that because its arguments are evaluated at runtime, they can be calculated by other code in ways that the compiletime version cannot. As the attributes are given in a key-value pair list, it is allowed to apply the same attribute multiple times; and the attributes are applied in the order given. The value of each attribute should be a plain string exactly as it would appear between the parentheses. Specifically, if the attribute does not use the `RAWDATA' flag, it should be a valid perl expression. As this is still evaluated using an `eval()' call, take care when handling potentially-unsafe or user-supplied data. $sub = apply_subattrs_for_pkg( $pkg, @attrs_kvlist, $sub ) As `apply_subattrs' but allows passing a specific package name, rather than using `caller'. %subs = find_subs_with_attr( $pkg, $attrname, %opts ) A utility function to find CODE references in the given package that have the name attribute applied. The symbol table is checked for the given package, looking for CODE references that have the named attribute applied. These are returned in a key-value list, where the key gives the name of the function and the value is a CODE reference to it. `$pkg' can also be a reference to an array containing multiple package names, which will be searched in order with earlier ones taking precedence over later ones. This, for example, allows for subclass searching over an entire class heirarchy of packages, via the use of mro: %subs = find_subs_with_attr( [ mro::get_linear_isa $class ], $attrname ); Takes the following named options: matching => Regexp | CODE If present, gives a filter regexp or CODE reference to apply to symbol names. $name =~ $matching $matching->( local $_ = $name ) filter => CODE If present, gives a filter CODE reference to apply to the function references before they are accepted as results. Note that this allows the possibility that the first match for a given method name to be rejected, while later ones are accepted. $filter->( $cv, $name, $package ) AUTHOR Paul Evans Attribute-Storage-0.09/Build.PL000444001750001750 77612334162322 15151 0ustar00leoleo000000000000use strict; use warnings; use Module::Build; my $build = Module::Build->new( module_name => 'Attribute::Storage', configure_requires => { 'Module::Build' => 0, 'Module::Build::Compat' => 0, }, requires => { 'XSLoader' => 0, }, build_requires => { 'Test::More' => '0.88', # done_testing 'Test::NoWarnings' => 0, }, license => 'perl', create_makefile_pl => 'small', create_license => 1, create_readme => 1, ); $build->create_build_script; Attribute-Storage-0.09/LICENSE000444001750001750 4376212334162322 14724 0ustar00leoleo000000000000This software is copyright (c) 2014 by Paul Evans . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2014 by Paul Evans . This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2014 by Paul Evans . This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. 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. The End Attribute-Storage-0.09/META.yml000444001750001750 125512334162322 15137 0ustar00leoleo000000000000--- abstract: 'declare and retrieve named attributes about CODE' author: - 'Paul Evans ' build_requires: ExtUtils::CBuilder: '0' Test::More: '0.88' Test::NoWarnings: '0' configure_requires: Module::Build: '0' Module::Build::Compat: '0' dynamic_config: 1 generated_by: 'Module::Build version 0.4205, CPAN::Meta::Converter version 2.133380' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Attribute-Storage provides: Attribute::Storage: file: lib/Attribute/Storage.pm version: '0.09' requires: XSLoader: '0' resources: license: http://dev.perl.org/licenses/ version: '0.09' Attribute-Storage-0.09/MANIFEST000444001750001750 40212334162322 14770 0ustar00leoleo000000000000Build.PL Changes lib/Attribute/Storage.pm lib/Attribute/Storage.xs LICENSE Makefile.PL MANIFEST This list of files META.json META.yml README t/00use.t t/01simple.t t/02value.t t/03raw.t t/04free.t t/05multi.t t/06subname.t t/07apply.t t/08find.t t/99pod.t Attribute-Storage-0.09/Makefile.PL000444001750001750 42512334162322 15616 0ustar00leoleo000000000000# Note: this file was auto-generated by Module::Build::Compat version 0.4205 use Module::Build::Compat 0.02; Module::Build::Compat->run_build_pl(args => \@ARGV); require Module::Build; Module::Build::Compat->write_makefile(build_class => 'Module::Build'); Attribute-Storage-0.09/lib000755001750001750 012334162322 14274 5ustar00leoleo000000000000Attribute-Storage-0.09/lib/Attribute000755001750001750 012334162322 16237 5ustar00leoleo000000000000Attribute-Storage-0.09/lib/Attribute/Storage.pm000444001750001750 3165412334162322 20367 0ustar00leoleo000000000000# You may distribute under the terms of either the GNU General Public License # or the Artistic License (the same terms as Perl itself) # # (C) Paul Evans, 2008-2014 -- leonerd@leonerd.org.uk package Attribute::Storage; use strict; use warnings; use Carp; our $VERSION = '0.09'; require XSLoader; XSLoader::load( __PACKAGE__, $VERSION ); use B qw( svref_2object ); =head1 NAME C - declare and retrieve named attributes about CODE references =head1 SYNOPSIS package My::Package; use Attribute::Storage; sub Title :ATTR(CODE) { my $package = shift; my ( $title ) = @_; return $title; } package main; use Attribute::Storage qw( get_subattr ); use My::Package; sub myfunc :Title('The title of my function') { ... } print "Title of myfunc is: ".get_subattr(\&myfunc, 'Title')."\n"; =head1 DESCRIPTION This package provides a base, where a package using it can define handlers for particular code attributes. Other packages, using the package that defines the code attributes, can then use them to annotate subs. This is similar to C, with the following key differences: =over 4 =item * C will store the value returned by the attribute handling code, and provides convenient lookup functions to retrieve it later. C simply invokes the handling code. =item * C immediately executes the attribute handling code at compile-time. C defers invocation so it can look up the symbolic name of the sub the attribute is attached to. C uses L to provide the name of the sub at invocation time, using the name of the underlying C. =item * C works just as well on anonymous subs as named ones. =item * C is safe to use on code that will be reloaded, because it executes handlers immediately. C will only execute handlers at defined phases such as C or C, and cannot reexecute the handlers in a file once it has been reloaded. =back =cut sub import { my $class = shift; return unless $class eq __PACKAGE__; # TODO #Attribute::Lexical->import( 'CODE:ATTR' => \&handle_attr_ATTR ); my $caller = caller; my $sub = sub { my ( $pkg, $ref, @attrs ) = @_; grep { my ( $attrname, $opts ) = m/^([A-Za-z_][0-9A-Za-z_]*)(?:\((.*)\))?$/s; defined $opts or $opts = ""; $attrname eq "ATTR" ? handle_attr_ATTR( $pkg, $ref, $attrname, $opts ) : handle_attr ( $pkg, $ref, $attrname, $opts ); } @attrs; }; no strict 'refs'; *{$caller . "::MODIFY_CODE_ATTRIBUTES"} = $sub; # Some simple Exporter-like logic. Just does function refs foreach my $symb ( @_ ) { $sub = __PACKAGE__->can( $symb ) or croak __PACKAGE__." has no function '$symb'"; *{$caller . "::$symb"} = $sub; } } =head1 ATTRIBUTES Each attribute that the defining package wants to define should be done using a marked subroutine, in a way similar to L. When a sub in the using package is marked with such an attribute, the code is executed, passing in the arguments. Whatever it returns is stored, to be returned later when queried by C or C. The return value must be defined, or else the attribute will be marked as a compile error for perl to handle accordingly. Only C attributes are supported at present. sub AttributeName :ATTR(CODE) { my $package = shift; my ( $attr, $args, $here ) = @_; ... return $value; } At attachment time, the optional string that may appear within brackets following the attribute's name is parsed as a Perl expression in list context. If this succeeds, the values are passed as a list to the handling code. If this fails, an error is returned to the perl compiler. If no string is present, then an empty list is passed to the handling code. package Defining; sub NameMap :ATTR(CODE) { my $package = shift; my @strings = @_; return { map { m/^(.*)=(.*)$/ and ( $1, $2 ) } @strings }; } package Using; use Defining; sub somefunc :NameMap("foo=FOO","bar=BAR","splot=WIBBLE") { ... } my $map = get_subattr("somefunc", "NameMap"); # Will yield: # { foo => "FOO", # bar => "BAR", # splot => "WIBBLE" } Note that it is impossible to distinguish sub somefunc :NameMap { ... } sub somefunc :NameMap() { ... } It is possible to create attributes that do not parse their argument as a perl list expression, instead they just pass the plain string as a single argument. For this, add the C flag to the C list. sub Title :ATTR(CODE,RAWDATA) { my $package = shift; my ( $text ) = @_; return $text; } sub thingy :Title(Here is the title for thingy) { ... } To obtain the name of the function to which the attribute is being applied, use the C flag to the C list. sub Callable :ATTR(CODE,NAME) { my $package = shift; my ( $subname, @args ) = @_; print "The Callable attribute is being applied to $package :: $subname\n"; return; } When applied to an anonymous function (C), the name will appear as C<__ANON__>. Normally it is an error to attempt to apply the same attribute more than once to the same function. Sometimes however, it would make sense for an attribute to be applied many times. If the C list is given the C flag, then applying it more than once will be allowed. Each invocation of the handling code will be given the previous value that was returned, or C for the first time. It is up to the code to perform whatever merging logic is required. sub Description :ATTR(CODE,MULTI,RAWDATA) { my $package = shift; my ( $olddesc, $more ) = @_; return defined $olddesc ? "$olddesc$more\n" : "$more\n"; } sub Argument :ATTR(CODE,MULTI) { my $package = shift; my ( $args, $argname ) = @_; push @$args, $argname; return $args; } sub Option :ATTR(CODE,MULTI) { my $package = shift; my ( $opts, $optname ) = @_; $opts and exists $opts->{$optname} and croak "Already have the $optname option"; $opts->{$optname}++; return $opts; } ... sub do_copy :Description(Copy from SOURCE to DESTINATION) :Description(Optionally preserves attributes) :Argument("SOURCE") :Argument("DESTINATION") :Option("attrs") :Option("verbose") { ... } =cut sub handle_attr_ATTR { my ( $pkg, $ref, undef, $opts ) = @_; my $attrs = _get_attr_hash( $ref, 1 ); my %type; foreach ( split m/\s*,\s*/, $opts ) { m/^CODE$/ and next; m/^SCALAR|HASH|ARRAY$/ and croak "Only CODE attributes are supported currently"; m/^RAWDATA$/ and ( $type{raw} = 1 ), next; m/^MULTI$/ and ( $type{multi} = 1 ), next; m/^NAME$/ and ( $type{name} = 1 ), next; croak "Unrecognised attribute option $_"; } $attrs->{ATTR} = \%type; return 0; } sub handle_attr { my ( $pkg, $ref, $attrname, $opts ) = @_; my $cv = $pkg->can( $attrname ) or return 1; my $cvattrs = _get_attr_hash( $cv, 0 ) or return 1; my $type = $cvattrs->{ATTR} or return 1; my @opts; if( $type->{raw} ) { @opts = ( $opts ); } else { @opts = do { no strict; defined $opts ? eval $opts : (); }; if( $@ ) { my ( $msg ) = $@ =~ m/^(.*) at \(eval \d+\) line \d+\.$/; croak "Unable to parse $attrname - $msg"; } } my $attrs = _get_attr_hash( $ref, 1 ); if( $type->{name} ) { unshift @opts, svref_2object( $ref )->GV->NAME; } if( $type->{multi} ) { unshift @opts, $attrs->{$attrname}; } else { exists $attrs->{$attrname} and croak "Already have the $attrname attribute"; } my $value = eval { $cv->( $pkg, @opts ) }; die $@ if $@; defined $value or return 1; $attrs->{$attrname} = $value; return 0; } =head1 FUNCTIONS =cut =head2 $attrs = get_subattrs( $sub ) Returns a HASH reference containing all the attributes defined on the given sub. The sub should either be passed as a CODE reference, or as a name in the caller's package. If no attributes are defined, a reference to an empty HASH is returned. The returned HASH reference is a new shallow clone, the caller may modify this hash arbitrarily without breaking the stored data, or other users of it. =cut sub get_subattrs { my ( $sub ) = @_; defined $sub or croak "Need a sub"; my $cv; if( ref $sub ) { $cv = $sub; } else { my $caller = caller; $cv = $caller->can( $sub ); defined $cv or croak "$caller has no sub $sub"; } return { %{ _get_attr_hash( $cv, 0 ) || {} } }; # clone } =head2 $value = get_subattr( $sub, $attrname ) Returns the value of a single named attribute on the given sub. The sub should either be passed as a CODE reference, or as a name in the caller's package. If the attribute is not defined, C is returned. =cut sub get_subattr { my ( $sub, $attr ) = @_; defined $sub or croak "Need a sub"; my $cv; if( ref $sub ) { $cv = $sub; } else { my $caller = caller; $cv = $caller->can( $sub ); defined $cv or croak "$caller has no sub $sub"; } my $attrhash = _get_attr_hash( $cv, 0 ) or return undef; return $attrhash->{$attr}; } =head2 $sub = apply_subattrs( @attrs_kvlist, $sub ) A utility function to help apply attributes dynamically to the given CODE reference. The CODE reference is given last so that calls to the function appear similar in visual style to the same applied at compiletime. apply_subattrs Title => "Here is my title", sub { return $title }; Is equivalent to sub :Title(Here is my title) { return $title } except that because its arguments are evaluated at runtime, they can be calculated by other code in ways that the compiletime version cannot. As the attributes are given in a key-value pair list, it is allowed to apply the same attribute multiple times; and the attributes are applied in the order given. The value of each attribute should be a plain string exactly as it would appear between the parentheses. Specifically, if the attribute does not use the C flag, it should be a valid perl expression. As this is still evaluated using an C call, take care when handling potentially-unsafe or user-supplied data. =head2 $sub = apply_subattrs_for_pkg( $pkg, @attrs_kvlist, $sub ) As C but allows passing a specific package name, rather than using C. =cut sub apply_subattrs_for_pkg { my $pkg = shift; my $sub = pop; while( @_ ) { my $attr = shift; my $value = shift; attributes->import( $pkg, $sub, "$attr($value)" ); } return $sub; } sub apply_subattrs { apply_subattrs_for_pkg( scalar caller, @_ ); } =head2 %subs = find_subs_with_attr( $pkg, $attrname, %opts ) A utility function to find CODE references in the given package that have the name attribute applied. The symbol table is checked for the given package, looking for CODE references that have the named attribute applied. These are returned in a key-value list, where the key gives the name of the function and the value is a CODE reference to it. C<$pkg> can also be a reference to an array containing multiple package names, which will be searched in order with earlier ones taking precedence over later ones. This, for example, allows for subclass searching over an entire class heirarchy of packages, via the use of L: %subs = find_subs_with_attr( [ mro::get_linear_isa $class ], $attrname ); Takes the following named options: =over 8 =item matching => Regexp | CODE If present, gives a filter regexp or CODE reference to apply to symbol names. $name =~ $matching $matching->( local $_ = $name ) =item filter => CODE If present, gives a filter CODE reference to apply to the function references before they are accepted as results. Note that this allows the possibility that the first match for a given method name to be rejected, while later ones are accepted. $filter->( $cv, $name, $package ) =back =cut sub find_subs_with_attr { my ( $pkg, $attrname, %opts ) = @_; my $matching = $opts{matching}; $matching = do { my $re = $matching; sub { $_ =~ $re } } if ref $matching eq "Regexp"; my $filter = $opts{filter}; my %ret; foreach $pkg ( ref $pkg ? @$pkg : $pkg ) { no strict 'refs'; foreach my $symname ( keys %{$pkg."::"} ) { # First definition wins exists $ret{$symname} and next; # Perl seems to cache mechods in derived class symbol tables # Skip these entries my $cv = $pkg->can( $symname ) or next; $matching and not $matching->( local $_ = $symname ) and next; next unless defined get_subattr( $cv, $attrname ); $filter and not $filter->( $cv, $symname, $pkg ) and next; $ret{$symname} = $cv; } } return %ret; } =head1 AUTHOR Paul Evans =cut 0x55AA; Attribute-Storage-0.09/lib/Attribute/Storage.xs000444001750001750 335412334162322 20361 0ustar00leoleo000000000000/* You may distribute under the terms of either the GNU General Public License * or the Artistic License (the same terms as Perl itself) * * (C) Paul Evans, 2009 -- leonerd@leonerd.org.uk */ #include "EXTERN.h" #include "perl.h" #include "XSUB.h" /* We don't actually use any magic routines; we apply magic simply for the * side-effect of having our own private mg_object field to store the * attributes hash. But we need a vtbl anyway. * Also we use it to have a unique address to use to recognise ourself */ static MGVTBL vtbl = { NULL, /* get */ NULL, /* set */ NULL, /* len */ NULL, /* clear */ NULL, /* free */ }; MODULE = Attribute::Storage PACKAGE = Attribute::Storage void _get_attr_hash(rv, create) SV *rv int create INIT: SV *subject; SV *hash = NULL; MAGIC *magic; PPCODE: if(!SvROK(rv)) croak("Cannot fetch attributes hash of a non-reference value"); subject = SvRV(rv); for(magic = mg_find(subject, PERL_MAGIC_ext); magic; magic = magic->mg_moremagic) { if(magic->mg_type == PERL_MAGIC_ext && magic->mg_virtual == &vtbl) { hash = magic->mg_obj; break; } } if(!hash && !create) XSRETURN_UNDEF; if(!hash) { hash = sv_2mortal((SV*)newHV()); /* sv_magicext() will inc the hash's refcount, we don't want it here */ magic = sv_magicext(subject, hash, PERL_MAGIC_ext, &vtbl, NULL, 0); /* Set the magic signature to 0; we'll use our vtable address to * reliably recognise our own structure. 0 means it's unlikely to be * falsely recognised by anyone else as belonging to them. */ magic->mg_private = 0; } XPUSHs(sv_2mortal(newRV_inc(hash))); XSRETURN(1); Attribute-Storage-0.09/t000755001750001750 012334162322 13771 5ustar00leoleo000000000000Attribute-Storage-0.09/t/05multi.t000444001750001750 125112334162322 15611 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr ); sub One :ATTR(CODE) { my $package = shift; 1; } sub Many :ATTR(CODE,MULTI) { my $package = shift; my ( $oldvalue ) = @_; return ++$oldvalue; } # We have to put my $dummy = ... or else the Perl compiler gets confused. # Reported to perl-p5p@ eval "my \$dummy = sub :One :One { 'XXX' }"; like( $@, qr/^Already have the One attribute /, 'Applying :One multiple times dies' ); my $coderef = eval "my \$dummy = sub :Many :Many :Many { 'XXX' }"; ok( !$@, 'Applying :Many succeeds' ); is( get_subattr( $coderef, "Many" ), 3, 'Value of Many is 3' ); done_testing; Attribute-Storage-0.09/t/00use.t000444001750001750 15412334162322 15227 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use_ok( "Attribute::Storage" ); done_testing; Attribute-Storage-0.09/t/03raw.t000444001750001750 65412334162322 15234 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr ); sub Title :ATTR(CODE,RAWDATA) { my $package = shift; my ( $text ) = @_; return $text; } # This title text would be a perl syntax error if it were not RAWDATA sub myfunc :Title(Here is my raw text) { } is( get_subattr( \&myfunc, "Title" ), "Here is my raw text", 'get_subattr Title on \&myfunc' ); done_testing; Attribute-Storage-0.09/t/04free.t000444001750001750 132312334162322 15377 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr ); my @destroyed; sub FreeGuard::DESTROY { push @destroyed, $_[0]->[0] } sub Value :ATTR(CODE) { my $package = shift; my ( $value ) = @_; return bless [ $value ], "FreeGuard"; } sub myfunc :Value("first generation") { } is_deeply( get_subattr( "myfunc", "Value" ), [ "first generation" ], 'First generation of attribute' ); { no warnings 'redefine'; *myfunc = sub :Value("second generation") {} } is_deeply( get_subattr( "myfunc", "Value" ), [ "second generation" ], 'Second generation of attribute' ); is_deeply( \@destroyed, [ "first generation" ], 'First generation got destroyed' ); done_testing; Attribute-Storage-0.09/t/07apply.t000444001750001750 67712334162322 15601 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr get_subattrs apply_subattrs ); sub Title :ATTR(CODE) { my $package = shift; my ( $title ) = @_; return "" unless defined $title; return $title; } my $code = apply_subattrs Title => '"Here is my title"', sub { }; is( get_subattr( $code, "Title" ), "Here is my title", 'apply_subattrs can set Title on $code' ); done_testing; Attribute-Storage-0.09/t/01simple.t000444001750001750 342312334162322 15747 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Test::NoWarnings (); use Attribute::Storage qw( get_subattr get_subattrs ); sub Title :ATTR(CODE) { my $package = shift; my ( $title ) = @_; return "" unless defined $title; return $title; } sub myfunc :Title('The title of myfunc') { } sub emptytitle :Title { } sub anotherfunc { } is( get_subattr( \&myfunc, "Title" ), "The title of myfunc", 'get_subattr Title on \&myfunc' ); is( get_subattr( "myfunc", "Title" ), "The title of myfunc", 'get_subattr Title on "myfunc"' ); is( get_subattr( \&myfunc, "Another" ), undef, 'get_subattr Another' ); is( get_subattr( \&anotherfunc, "Title" ), undef, 'get_subattr Title on \&another' ); is_deeply( get_subattrs( \&myfunc ), { Title => "The title of myfunc" }, 'get_subattrs' ); my $coderef; $coderef = sub :Title('Dynamic code') { 1 }; is( get_subattr( $coderef, "Title" ), "Dynamic code", 'get_subattr Title on anon CODE' ); # We have to put my $dummy = ... or else the Perl compiler gets confused. # Reported to perl-p5p@ $coderef = eval "my \$dummy = sub :Title('eval code') { 2 }" or die $@; is( get_subattr( $coderef, "Title" ), "eval code", 'get_subattr Title on anon CODE from eval' ); $coderef = sub { 1 }; attributes->import( main => $coderef, "Title('attributes import')" ); is( get_subattr( $coderef, "Title" ), "attributes import", 'get_subattr Title on anon CODE from attributes->import application' ); { package OtherPackage; $coderef = sub { 2 }; attributes->import( main => $coderef, "Title('import in other package')" ); } is( get_subattr( $coderef, "Title" ), "import in other package", 'get_subattr Title on anon CODE ref in another package using attributes->import' ); Test::NoWarnings::had_no_warnings; done_testing; Attribute-Storage-0.09/t/06subname.t000444001750001750 124012334162322 16110 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr ); sub Foo :ATTR(CODE,NAME) { my ( $package, $subname, @values ) = @_; return { package => $package, subname => $subname, values => \@values, }; } sub myfunc :Foo("red","blue") { } is_deeply( get_subattr( \&myfunc, "Foo" ), { package => "main", subname => "myfunc", values => [ "red", "blue" ] }, 'sub name visible for :ATTR(NAME)' ); is_deeply( get_subattr( sub :Foo("green") { }, "Foo" ), { package => "main", subname => "__ANON__", values => [ "green" ] }, 'sub name for :ATTR(NAME) on anonymous function' ); done_testing; Attribute-Storage-0.09/t/99pod.t000444001750001750 25712334162322 15243 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok(); Attribute-Storage-0.09/t/08find.t000444001750001750 325712334162322 15412 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( find_subs_with_attr ); { package Testing; use Attribute::Storage; sub Title :ATTR(CODE) { my $package = shift; my ( $title ) = @_; return $title; } sub one :Title("One") { 1 } sub two :Title("Two") { 2 } sub three :Title("Three") { 3 } package SubClass; use base qw( Testing ); sub four :Title("Four") {} } my %subs = find_subs_with_attr "Testing", "Title"; is( $subs{one}, \&Testing::one, 'find_subs_with_attr finds sub one()' ); is( $subs{two}, \&Testing::two, 'find_subs_with_attr finds sub two()' ); is( $subs{three}, \&Testing::three, 'find_subs_with_attr finds sub three()' ); %subs = find_subs_with_attr( [qw( SubClass Testing )], "Title" ); is( $subs{one}, \&Testing::one, 'find_subs_with_attr on subclass finds parent subs' ); # matching { my %subs = find_subs_with_attr "Testing", "Title", matching => sub { length == 3 }; ok( defined $subs{one}, 'find_subs_with_attr matching CODE finds one' ); ok( !defined $subs{three}, 'find_subs_with_attr matching CODE does not find three' ); %subs = find_subs_with_attr "Testing", "Title", matching => qr/^...$/; ok( defined $subs{one}, 'find_subs_with_attr matching Regexp finds one' ); ok( !defined $subs{three}, 'find_subs_with_attr matching Regexp does not find three' ); } # filter { my %subs = find_subs_with_attr "Testing", "Title", filter => sub { my ( $cv ) = @_; return $cv->() % 2; }; ok( defined $subs{one}, 'find_subs_with_attr filter finds one' ); ok( !defined $subs{two}, 'find_subs_with_attr filter does not find two' ); } done_testing; Attribute-Storage-0.09/t/02value.t000444001750001750 56412334162322 15556 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Attribute::Storage qw( get_subattr ); sub Number :ATTR(CODE) { my $package = shift; my ( @values ) = @_; my $total; $total += $_ for @values; return $total; } sub myfunc :Number(1,2,3,4,5) { } is( get_subattr( \&myfunc, "Number" ), 15, 'get_subattr Number on \&myfunc' ); done_testing;