Hook-WrapSub-0.08/000755 000767 000024 00000000000 14067547255 014554 5ustar00janitorstaff000000 000000 Hook-WrapSub-0.08/LICENSE000644 000767 000024 00000043660 14067547255 015572 0ustar00janitorstaff000000 000000 This software is copyright (c) 1999 by John D Porter. 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) 1999 by John D Porter. 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) 1999 by John D Porter. 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 Hook-WrapSub-0.08/Changes000644 000767 000024 00000002535 14067547255 016054 0ustar00janitorstaff000000 000000 Revision history for Perl module Hook::WrapSub 0.08 2021-07-02 NEILB - Added a simple README - Switched to github issues for the bug tracker 0.07 2016-02-04 NEILB - Added myself to the AUTHOR section, as suggested by the original author John Porter in RT#111728 - Added a better introductory paragraph to the pod, saying what the module does. - Moved all the pod to the end of the file. 0.06 2016-02-03 NEILB - Added links to Class::Method::Modifiers & Moose::Manual::MethodModifiers in SEE ALSO. Thanks to ETHER. 0.05 2015-11-10 NEILB - Changed github repo URL after changing my github username - Added [MetaJSON] to dist.ini so META.json is included in releases - Tag and push to github when I run "dzil release" 0.04 2014-06-21 - Non-developer release - changes as per 0.03_01 release 0.03_01 2014-06-19 - Switched to Dist::Zilla - Moved test.pl to t/01-basic.t - Added SEE ALSO section, with links to, and descriptions of, similar modules. - Added github repo to pod - Reformatted Changes as per CPAN::Changes::Spec 0.03 2000-02-01 JDPORTER - Fixed bug: sense of wantarray was inverted 0.02 1999-11-03 JDPORTER - First release to CPAN - Added ability to wrap subs in other namespaces. 0.01 1999-10-14 - original version; created by John Porter, via h2xs 1.19 Hook-WrapSub-0.08/MANIFEST000644 000767 000024 00000000272 14067547255 015706 0ustar00janitorstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.017. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README dist.ini lib/Hook/WrapSub.pm t/01-basic.t Hook-WrapSub-0.08/t/000755 000767 000024 00000000000 14067547255 015017 5ustar00janitorstaff000000 000000 Hook-WrapSub-0.08/README000644 000767 000024 00000001301 14067547255 015427 0ustar00janitorstaff000000 000000 Hook::WrapSub - a Perl module wrapping subs This distribution contains a Perl module which lets you wrap a sub with either or both of functions that are called just before or just after the sub. You can read a nicely formatted version of the documentation for this module online: https://metacpan.org/pod/Hook::WrapSub You should be able to install this using your usual method for installing modules from CPAN. If you don't have a usual method, have a look at: http://www.cpan.org/modules/INSTALL.html This software is copyright (c) 1999 John Porter This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Hook-WrapSub-0.08/META.yml000644 000767 000024 00000001562 14067547255 016031 0ustar00janitorstaff000000 000000 --- abstract: 'wrap subs with pre- and post-call hooks' author: - 'John D Porter ' - 'Neil Bowers ' build_requires: Test::More: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.017, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Hook-WrapSub requires: Exporter: '0' Symbol: '0' perl: '5.006' strict: '0' warnings: '0' resources: bugtracker: https://github.com/cpan-janitor/Hook-WrapSub/issues homepage: https://github.com/cpan-janitor/Hook-WrapSub repository: https://github.com/cpan-janitor/Hook-WrapSub.git version: '0.08' x_generated_by_perl: v5.28.2 x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' Hook-WrapSub-0.08/lib/000755 000767 000024 00000000000 14067547255 015322 5ustar00janitorstaff000000 000000 Hook-WrapSub-0.08/Makefile.PL000644 000767 000024 00000002234 14067547255 016527 0ustar00janitorstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.017. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "wrap subs with pre- and post-call hooks", "AUTHOR" => "John D Porter , Neil Bowers ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "Hook-WrapSub", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.006", "NAME" => "Hook::WrapSub", "PREREQ_PM" => { "Exporter" => 0, "Symbol" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "Test::More" => 0 }, "VERSION" => "0.08", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Exporter" => 0, "Symbol" => 0, "Test::More" => 0, "strict" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); Hook-WrapSub-0.08/META.json000644 000767 000024 00000002723 14067547255 016201 0ustar00janitorstaff000000 000000 { "abstract" : "wrap subs with pre- and post-call hooks", "author" : [ "John D Porter ", "Neil Bowers " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.017, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Hook-WrapSub", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "runtime" : { "requires" : { "Exporter" : "0", "Symbol" : "0", "perl" : "5.006", "strict" : "0", "warnings" : "0" } }, "test" : { "requires" : { "Test::More" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/cpan-janitor/Hook-WrapSub/issues" }, "homepage" : "https://github.com/cpan-janitor/Hook-WrapSub", "repository" : { "type" : "git", "url" : "https://github.com/cpan-janitor/Hook-WrapSub.git", "web" : "https://github.com/cpan-janitor/Hook-WrapSub" } }, "version" : "0.08", "x_generated_by_perl" : "v5.28.2", "x_serialization_backend" : "Cpanel::JSON::XS version 4.24", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } Hook-WrapSub-0.08/dist.ini000644 000767 000024 00000000524 14067547255 016221 0ustar00janitorstaff000000 000000 name = Hook-WrapSub author = John D Porter author = Neil Bowers license = Perl_5 copyright_holder = John D Porter copyright_year = 1999 version = 0.08 [@Filter] -bundle = @Basic -remove = Readme [PkgVersion] [AutoPrereqs] [MetaJSON] [GithubMeta] issues = 1 [Git::Tag] tag_message= [Git::Push] Hook-WrapSub-0.08/lib/Hook/000755 000767 000024 00000000000 14067547255 016222 5ustar00janitorstaff000000 000000 Hook-WrapSub-0.08/lib/Hook/WrapSub.pm000644 000767 000024 00000022472 14067547255 020152 0ustar00janitorstaff000000 000000 package Hook::WrapSub; $Hook::WrapSub::VERSION = '0.08'; use 5.006; use strict; use warnings; use Exporter; use Symbol; our @ISA = qw/ Exporter /; our @EXPORT_OK = qw/ wrap_subs unwrap_subs /; sub wrap_subs(@) { my( $precall_cr, $postcall_cr ); ref($_[0]) and $precall_cr = shift; ref($_[-1]) and $postcall_cr = pop; my @names = @_; my( $calling_package ) = caller; for my $name ( @names ) { my $fullname; my $sr = *{ qualify_to_ref($name,$calling_package) }{CODE}; if ( defined $sr ) { $fullname = qualify($name,$calling_package); } else { warn "Can't find subroutine named '$name'\n"; next; } my $cr = sub { $Hook::WrapSub::UNWRAP and return $sr; # # this is a bunch of kludg to make a list of values # that look like a "real" caller() result. # my $up = 0; my @args = caller($up); while ( $args[0] =~ /Hook::WrapSub/ ) { $up++; @args = caller($up); } my @vargs = @args; # save temp while ( defined($args[3]) && $args[3] =~ /Hook::WrapSub/ ) { $up++; @args = caller($up); } $vargs[3] = $args[3]; # now @vargs looks right. local $Hook::WrapSub::name = $fullname; local @Hook::WrapSub::result = (); local @Hook::WrapSub::caller = @vargs; my $wantarray = $Hook::WrapSub::caller[5]; # # try to supply the same calling context to the nested sub: # unless ( defined $wantarray ) { # void context &$precall_cr if $precall_cr; &$sr; &$postcall_cr if $postcall_cr; return(); } unless ( $wantarray ) { # scalar context &$precall_cr if $precall_cr; $Hook::WrapSub::result[0] = &$sr; &$postcall_cr if $postcall_cr; return $Hook::WrapSub::result[0]; } # list context &$precall_cr if $precall_cr; @Hook::WrapSub::result = &$sr; &$postcall_cr if $postcall_cr; return( @Hook::WrapSub::result ); }; no warnings 'redefine'; no strict 'refs'; *{ $fullname } = $cr; } } sub unwrap_subs(@) { my @names = @_; my( $calling_package ) = caller; for my $name ( @names ) { my $fullname; my $sr = *{ qualify_to_ref($name,$calling_package) }{CODE}; if ( defined $sr ) { $fullname = qualify($name,$calling_package); } else { warn "Can't find subroutine named '$name'\n"; next; } local $Hook::WrapSub::UNWRAP = 1; my $cr = $sr->(); if ( defined $cr and $cr =~ /\bCODE\b/ ) { no strict 'refs'; no warnings 'redefine'; *{ $fullname } = $cr; } else { warn "Subroutine '$fullname' not wrapped!"; } } } 1; =head1 NAME Hook::WrapSub - wrap subs with pre- and post-call hooks =head1 SYNOPSIS use Hook::WrapSub qw( wrap_subs unwrap_subs ); wrap_subs \&before, 'some_func', 'another_func', \&after; unwrap_subs 'some_func'; =head1 DESCRIPTION This module lets you wrap a function, providing one or both of functions that are called just before and just after, whenever the wrapped function is called. There are a number of other modules that provide the same functionality as this module, some of them better. Have a look at the list in SEE ALSO, below, before you decide which to use. =head2 wrap_subs This function enables intercepting a call to any named function; handlers may be added both before and after the call to the intercepted function. For example: wrap_subs \&before, 'some_func', \&after; In this case, whenever the sub named 'some_func' is called, the &before sub is called first, and the &after sub is called afterwards. These are both optional. If you only want to intercept the call beforehand: wrap_subs \&before, 'some_func'; You may pass more than one sub name: wrap_subs \&before, 'foo', 'bar', 'baz', \&after; and each one will have the same hooks applied. The sub names may be qualified. Any unqualified names are assumed to reside in the package of the caller. The &before sub and the &after sub are both passed the argument list which is destined for the wrapped sub. This can be inspected, and even altered, in the &before sub: sub before { ref($_[1]) && $_[1] =~ /\bARRAY\b/ or croak "2nd arg must be an array-ref!"; @_ or @_ = qw( default values ); # if no args passed, insert some default values } The &after sub is also passed this list. Modifications to it will (obviously) not be seen by the wrapped sub, but the caller will see the changes, if it happens to be looking. Here's an example that causes a certain method call to be redirected to a specific object. (Note, we use splice to change $_[0], because assigning directly to $_[0] would cause the change to be visible to the caller, due to the magical aliasing nature of @_.) my $handler_object = new MyClass; Hook::WrapSub::wrap_subs sub { splice @_, 0, 1, $handler_object }, 'MyClass::some_method'; my $other_object = new MyClass; $other_object->some_method; # even though the method is invoked on # $other_object, it will actually be executed # with a 0'th argument = $handler_obj, # as arranged by the pre-call hook sub. =head2 Package Variables There are some Hook::WrapSub package variables defined, which the &before and &after subs may inspect. =over 4 =item $Hook::WrapSub::name This is the fully qualified name of the wrapped sub. =item @Hook::WrapSub::caller This is a list which strongly resembles the result of a call to the built-in function C; it is provided because calling C will in fact produce confusing results; if your sub is inclined to call C, have it look at this variable instead. =item @Hook::WrapSub::result This contains the result of the call to the wrapped sub. It is empty in the &before sub. In the &after sub, it will be empty if the sub was called in a void context, it will contain one value if the sub was called in a scalar context; otherwise, it may have any number of elements. Note that the &after function is not prevented from modifying the contents of this array; any such modifications will be seen by the caller! =back This simple example shows how Hook::WrapSub can be used to log certain subroutine calls: sub before { print STDERR <<" EOF"; About to call $Hook::WrapSub::name( @_ ); Wantarray=$Hook::WrapSub::caller[5] EOF } sub after { print STDERR <<" EOF"; Called $Hook::WrapSub::name( @_ ); Result=( @Hook::WrapSub::result ) EOF @Hook::WrapSub::result or @Hook::WrapSub::result = qw( default return ); # if the sub failed to return something... } Much more elaborate uses are possible. Here's one one way it could be used with database operations: my $dbh; # initialized elsewhere. wrap_subs sub { $dbh->checkpoint }, 'MyDb::update', 'MyDb::delete', sub { # examine result of sub call: if ( $Hook::WrapSub::result[0] ) { # success $dbh->commit; } else { # failure $dbh->rollback; } }; =head2 unwrap_subs This removes the most recent wrapping of the named subs. NOTE: Any given sub may be wrapped an unlimited number of times. A "stack" of the wrappings is maintained internally. wrap_subs "pushes" a wrapping, and unwrap_subs "pops". =head1 SEE ALSO L provides a similar capability to C, but has the benefit that the C function works correctly within the wrapped subroutine. L lets you provide a sub that will be called before a named sub. The C function works correctly in the wrapped sub. L provides a number of related functions. You can provide pre- and post-call hooks, you can temporarily override a function and then restore it later, and more. L lets you add pre- and post-call hooks around any methods called by your code. It doesn't support functions. L lets you register callbacks that will be invoked when execution leaves the scope they were registered in. L provides an OO interface for wrapping a function with pre- and post-call hook functions. Last updated in 1997, and marked as alpha. L provides an OO interface for wrapping pre- and post-call hooks around functions or methods in a package. Not updated sinc 2003, and has a 20% failed rate on CPAN Testers. L describes L's mechanism for hooking a superclass's method. The I and I subs are called immediately before or after the specified methods are called. The I sub wraps the superclass method, and can even decide not to invoke the superclass method. L provides a L-style mechanism for a subclass to have I, I, or I method modifiers. L provides the C function, which takes a coderef and a package name. The coderef is invoked every time a method in the package is called. L lets you stack pre- and post-call hooks. Last updated in 2001. =head1 REPOSITORY L =head1 AUTHOR This module was written by John Porter Ejdporter@min.netE It is now being maintained by Neil Bowers. =head1 COPYRIGHT This is free software. This software may be modified and/or distributed under the same terms as Perl itself. =cut Hook-WrapSub-0.08/t/01-basic.t000644 000767 000024 00000001716 14067547255 016510 0ustar00janitorstaff000000 000000 #! perl use 5.006; use strict; use warnings; use Test::More tests => 1; use Hook::WrapSub qw( wrap_subs unwrap_subs ); my $expected = <<'END_EXPECTED'; 0B('0')[0] foo('0') 0A('0')[0] 1B('1')[1] 0B('X')[1] foo('X') 0A('X')[1] 1A('X')[1] 0B('2')[undef] foo('2') 0A('2')[undef] foo('3') END_EXPECTED my $result = ''; sub foo { $result .= "foo(@_)\n" } wrap_subs sub { $result .= "0B(@_)[".caller_wantarray()."]\n" }, 'foo', sub { $result .= "0A(@_)[".caller_wantarray()."]\n" } ; my $r = foo( "'0'" ); wrap_subs sub { $result .= "1B(@_)[".caller_wantarray()."]\n"; @_ = ("'X'"); }, 'foo', sub { $result .= "1A(@_)[".caller_wantarray()."]\n" } ; my @r = foo( "'1'" ); unwrap_subs 'foo' ; foo( "'2'" ); unwrap_subs 'foo' ; foo( "'3'" ); is($result, $expected); sub caller_wantarray { my $wantarray = $Hook::WrapSub::caller[5]; if (not defined $wantarray) { return 'undef'; } else { return $wantarray ? 1 : 0; } }