commit 4759faca4b60af72fd956d26468c06b671658ef7 Author: denghao Date: Fri Sep 2 08:39:13 2022 +0300 Import Upstream version 0.002 diff --git a/Changes b/Changes new file mode 100644 index 0000000..3a06e9a --- /dev/null +++ b/Changes @@ -0,0 +1,7 @@ +0.002 2016-12-23 20:15:51-08:00 America/Los_Angeles + + - Fix test + +0.001 2016-12-23 15:08:18-08:00 America/Los_Angeles + + - Initial Release (Copied from Test2::Suite) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9baddef --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2016 by Chad Granum. + +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) 2016 by Chad Granum. + +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) 2016 by Chad Granum. + +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 + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..69787ee --- /dev/null +++ b/MANIFEST @@ -0,0 +1,12 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.008. +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +README.md +cpanfile +lib/Sub/Info.pm +t/Sub.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..13f4f9d --- /dev/null +++ b/META.json @@ -0,0 +1,54 @@ +{ + "abstract" : "Tool for inspecting subroutines.", + "author" : [ + "Chad Granum " + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.150010", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "Sub-Info", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "develop" : { + "requires" : { + "Test::Pod" : "1.41" + } + }, + "runtime" : { + "requires" : { + "B" : "0", + "Carp" : "0", + "Importer" : "0.024", + "perl" : "5.008001" + } + }, + "test" : { + "requires" : { + "Test2::Tools::Tiny" : "1.302072" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "http://github.com/exodist/Sub-Info/issues" + }, + "repository" : { + "type" : "git", + "url" : "http://github.com/exodist/Sub-Info/" + } + }, + "version" : "0.002", + "x_serialization_backend" : "Cpanel::JSON::XS version 3.0217" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..f91d981 --- /dev/null +++ b/META.yml @@ -0,0 +1,25 @@ +--- +abstract: 'Tool for inspecting subroutines.' +author: + - 'Chad Granum ' +build_requires: + Test2::Tools::Tiny: '1.302072' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 6.008, 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: Sub-Info +requires: + B: '0' + Carp: '0' + Importer: '0.024' + perl: '5.008001' +resources: + bugtracker: http://github.com/exodist/Sub-Info/issues + repository: http://github.com/exodist/Sub-Info/ +version: '0.002' +x_serialization_backend: 'YAML::Tiny version 1.69' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..91dc6b9 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,51 @@ +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.008. +use strict; +use warnings; + +use 5.008001; + +use ExtUtils::MakeMaker; + +my %WriteMakefileArgs = ( + "ABSTRACT" => "Tool for inspecting subroutines.", + "AUTHOR" => "Chad Granum ", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "Sub-Info", + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.008001", + "NAME" => "Sub::Info", + "PREREQ_PM" => { + "B" => 0, + "Carp" => 0, + "Importer" => "0.024" + }, + "TEST_REQUIRES" => { + "Test2::Tools::Tiny" => "1.302072" + }, + "VERSION" => "0.002", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "B" => 0, + "Carp" => 0, + "Importer" => "0.024", + "Test2::Tools::Tiny" => "1.302072" +); + + +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); diff --git a/README b/README new file mode 100644 index 0000000..198e678 --- /dev/null +++ b/README @@ -0,0 +1,101 @@ +NAME + + Sub::Info - Tool for inspecting subroutines. + +DESCRIPTION + + Tool to inspect subroutines. + +EXPORTS + + All exports are optional, you must specify subs to import. + + my $hr = sub_info(\&code) + + my $hr = sub_info(\&code, @line_numbers) + + This returns a hashref with information about the sub: + + { + ref => \&code, + cobj => $cobj, + name => "Some::Mod::code", + file => "Some/Mod.pm", + package => "Some::Mod", + + # Note: These have been adjusted based on guesswork. + start_line => 22, + end_line => 42, + lines => [22, 42], + + # Not a bug, these lines are different! + all_lines => [23, 25, ..., 39, 41], + }; + + $info->{ref} => \&code + + This is the original sub passed to sub_info(). + + $info->{cobj} => $cobj + + This is the c-object representation of the coderef. + + $info->{name} => "Some::Mod::code" + + This is the name of the coderef. For anonymous coderefs this may + end with '__ANON__'. Also note that the package 'main' is special, + and 'main::' may be omitted. + + $info->{file} => "Some/Mod.pm" + + The file in which the sub was defined. + + $info->{package} => "Some::Mod" + + The package in which the sub was defined. + + $info->{start_line} => 22 + + $info->{end_line} => 42 + + $info->{lines} => [22, 42] + + These three fields are the adjusted start line, end line, and array + with both. It is important to note that these lines have been + adjusted and may not be accurate. + + The lines are obtained by walking the ops. As such, the first line + is the line of the first statement, and the last line is the line + of the last statement. This means that in multi-line subs the lines + are usually off by 1. The lines in these keys will be adjusted for + you if it detects a multi-line sub. + + $info->{all_lines} => [23, 25, ..., 39, 41] + + This is an array with the lines of every statement in the sub. + Unlike the other line fields, these have not been adjusted for you. + +SOURCE + + The source code repository for Sub-Info can be found at + http://github.com/exodist/Sub-Info/. + +MAINTAINERS + + Chad Granum + +AUTHORS + + Chad Granum + + Kent Fredric + +COPYRIGHT + + Copyright 2016 Chad Granum . + + This program is free software; you can redistribute it and/or modify it + under the same terms as Perl itself. + + See http://dev.perl.org/licenses/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..99e4867 --- /dev/null +++ b/README.md @@ -0,0 +1,95 @@ +# NAME + +Sub::Info - Tool for inspecting subroutines. + +# DESCRIPTION + +Tool to inspect subroutines. + +# EXPORTS + +All exports are optional, you must specify subs to import. + +- my $hr = sub\_info(\\&code) +- my $hr = sub\_info(\\&code, @line\_numbers) + + This returns a hashref with information about the sub: + + { + ref => \&code, + cobj => $cobj, + name => "Some::Mod::code", + file => "Some/Mod.pm", + package => "Some::Mod", + + # Note: These have been adjusted based on guesswork. + start_line => 22, + end_line => 42, + lines => [22, 42], + + # Not a bug, these lines are different! + all_lines => [23, 25, ..., 39, 41], + }; + + - $info->{ref} => \\&code + + This is the original sub passed to `sub_info()`. + + - $info->{cobj} => $cobj + + This is the c-object representation of the coderef. + + - $info->{name} => "Some::Mod::code" + + This is the name of the coderef. For anonymous coderefs this may end with + `'__ANON__'`. Also note that the package 'main' is special, and 'main::' may + be omitted. + + - $info->{file} => "Some/Mod.pm" + + The file in which the sub was defined. + + - $info->{package} => "Some::Mod" + + The package in which the sub was defined. + + - $info->{start\_line} => 22 + - $info->{end\_line} => 42 + - $info->{lines} => \[22, 42\] + + These three fields are the _adjusted_ start line, end line, and array with both. + It is important to note that these lines have been adjusted and may not be + accurate. + + The lines are obtained by walking the ops. As such, the first line is the line + of the first statement, and the last line is the line of the last statement. + This means that in multi-line subs the lines are usually off by 1. The lines + in these keys will be adjusted for you if it detects a multi-line sub. + + - $info->{all\_lines} => \[23, 25, ..., 39, 41\] + + This is an array with the lines of every statement in the sub. Unlike the other + line fields, these have not been adjusted for you. + +# SOURCE + +The source code repository for Sub-Info can be found at +`http://github.com/exodist/Sub-Info/`. + +# MAINTAINERS + +- Chad Granum + +# AUTHORS + +- Chad Granum +- Kent Fredric + +# COPYRIGHT + +Copyright 2016 Chad Granum . + +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +See `http://dev.perl.org/licenses/` diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..eed0018 --- /dev/null +++ b/cpanfile @@ -0,0 +1,16 @@ +requires "B" => "0"; +requires "Carp" => "0"; +requires "Importer" => "0.024"; +requires "perl" => "5.008001"; + +on 'test' => sub { + requires "Test2::Tools::Tiny" => "1.302072"; +}; + +on 'configure' => sub { + requires "ExtUtils::MakeMaker" => "0"; +}; + +on 'develop' => sub { + requires "Test::Pod" => "1.41"; +}; diff --git a/lib/Sub/Info.pm b/lib/Sub/Info.pm new file mode 100644 index 0000000..66a1405 --- /dev/null +++ b/lib/Sub/Info.pm @@ -0,0 +1,183 @@ +package Sub::Info; +use strict; +use warnings; + +our $VERSION = '0.002'; + +use Carp qw/croak/; +use B(); + +use Importer Importer => 'import'; +our @EXPORT_OK = qw{ sub_info }; + +sub sub_info { + my ($sub, @all_lines) = @_; + my %in = map {$_ => 1} @all_lines; + + croak "sub_info requires a coderef as its first argument" + unless ref($sub) eq 'CODE'; + + my $cobj = B::svref_2object($sub); + my $name = $cobj->GV->NAME; + my $file = $cobj->FILE; + my $package = $cobj->GV->STASH->NAME; + + my $op = $cobj->START; + while ($op) { + push @all_lines => $op->line if $op->can('line'); + last unless $op->can('next'); + $op = $op->next; + } + + my ($start, $end, @lines); + if (@all_lines) { + @all_lines = sort { $a <=> $b } @all_lines; + ($start, $end) = ($all_lines[0], $all_lines[-1]); + + # Adjust start and end for the most common case of a multi-line block with + # parens on the lines before and after. + if ($start < $end) { + $start-- unless $start <= 1 || $in{$start}; + $end++ unless $in{$end}; + } + @lines = ($start, $end); + } + + return { + ref => $sub, + cobj => $cobj, + name => $name, + file => $file, + package => $package, + start_line => $start, + end_line => $end, + all_lines => \@all_lines, + lines => \@lines, + }; +} + +1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Sub::Info - Tool for inspecting subroutines. + +=head1 DESCRIPTION + +Tool to inspect subroutines. + +=head1 EXPORTS + +All exports are optional, you must specify subs to import. + +=over 4 + +=item my $hr = sub_info(\&code) + +=item my $hr = sub_info(\&code, @line_numbers) + +This returns a hashref with information about the sub: + + { + ref => \&code, + cobj => $cobj, + name => "Some::Mod::code", + file => "Some/Mod.pm", + package => "Some::Mod", + + # Note: These have been adjusted based on guesswork. + start_line => 22, + end_line => 42, + lines => [22, 42], + + # Not a bug, these lines are different! + all_lines => [23, 25, ..., 39, 41], + }; + +=over 4 + +=item $info->{ref} => \&code + +This is the original sub passed to C. + +=item $info->{cobj} => $cobj + +This is the c-object representation of the coderef. + +=item $info->{name} => "Some::Mod::code" + +This is the name of the coderef. For anonymous coderefs this may end with +C<'__ANON__'>. Also note that the package 'main' is special, and 'main::' may +be omitted. + +=item $info->{file} => "Some/Mod.pm" + +The file in which the sub was defined. + +=item $info->{package} => "Some::Mod" + +The package in which the sub was defined. + +=item $info->{start_line} => 22 + +=item $info->{end_line} => 42 + +=item $info->{lines} => [22, 42] + +These three fields are the I start line, end line, and array with both. +It is important to note that these lines have been adjusted and may not be +accurate. + +The lines are obtained by walking the ops. As such, the first line is the line +of the first statement, and the last line is the line of the last statement. +This means that in multi-line subs the lines are usually off by 1. The lines +in these keys will be adjusted for you if it detects a multi-line sub. + +=item $info->{all_lines} => [23, 25, ..., 39, 41] + +This is an array with the lines of every statement in the sub. Unlike the other +line fields, these have not been adjusted for you. + +=back + +=back + +=head1 SOURCE + +The source code repository for Sub-Info can be found at +F. + +=head1 MAINTAINERS + +=over 4 + +=item Chad Granum Eexodist@cpan.orgE + +=back + +=head1 AUTHORS + +=over 4 + +=item Chad Granum Eexodist@cpan.orgE + +=item Kent Fredric Ekentnl@cpan.orgE + +=back + +=head1 COPYRIGHT + +Copyright 2016 Chad Granum Eexodist@cpan.orgE. + +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +See F + +=cut diff --git a/t/Sub.t b/t/Sub.t new file mode 100644 index 0000000..cca7731 --- /dev/null +++ b/t/Sub.t @@ -0,0 +1,120 @@ +use Test2::Tools::Tiny; +use strict; +use warnings; + +use Sub::Info qw/sub_info/; + +ok(__PACKAGE__->can('sub_info'), "Imported sub_info"); + +sub named { 'named' } + +no warnings 'once'; +sub empty_named { } my $empty_named = __LINE__ + 0; +*empty_anon = sub { }; my $empty_anon = __LINE__ + 0; + +sub one_line_named { 1 } my $one_line_named = __LINE__ + 0; +*one_line_anon = sub { 1 }; my $one_line_anon = __LINE__ + 0; + +my $multi_line_named_start = __LINE__ + 1; +sub multi_line_named { + my $x = 1; + $x++; + return $x; +} +my $multi_line_named_end = __LINE__ - 1; + +my $multi_line_anon_start = __LINE__ + 1; +*multi_line_anon = sub { + my $x = 1; + $x++; + return $x; +}; +my $multi_line_anon_end = __LINE__ - 1; +use warnings 'once'; + +my $info; + +$info = sub_info(\&empty_named); +like($info->{name}, qr/empty_named$/, "Got name"); +is($info->{package}, __PACKAGE__, "got package"); +is($info->{file}, __FILE__, "got file"); +is($info->{ref}, \&empty_named, "got reference"); +ok($info->{cobj}, "got cobj"); +ok(!defined($info->{start_line}) || $info->{start_line} == $empty_named, "Start line seems right"); +ok(!defined($info->{end_line}) || $info->{end_line} == $empty_named, "End line seems right"); + +$info = sub_info(\&empty_anon); +like($info->{name} , qr/__ANON__$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&empty_anon, "got ref"); +ok(!defined($info->{start_line}) || $info->{start_line} == $empty_anon, "Start line seems right"); +ok(!defined($info->{end_line}) || $info->{end_line} == $empty_anon, "End line seems right"); + +$info = sub_info(\&one_line_named); +like($info->{name} , qr/one_line_named$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&one_line_named, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , $one_line_named, "got start line"); +is($info->{end_line} , $one_line_named, "got end line"); +is_deeply($info->{lines} , [$one_line_named, $one_line_named], "got lines"); +is_deeply($info->{all_lines} , [$one_line_named], "got all lines"); + +$info = sub_info(\&one_line_anon); +like($info->{name} , qr/__ANON__$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&one_line_anon, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , $one_line_anon, "got start line"); +is($info->{end_line} , $one_line_anon, "got end line"); +is_deeply($info->{lines} , [$one_line_anon, $one_line_anon], "got lines"); +is_deeply($info->{all_lines} , [$one_line_anon], "got all lines"); + +$info = sub_info(\&multi_line_named); +like($info->{name} , qr/multi_line_named$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&multi_line_named, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , $multi_line_named_start, "got start line"); +is($info->{end_line} , $multi_line_named_end, "got end line"); +is_deeply($info->{lines} , [$multi_line_named_start, $multi_line_named_end], "got lines"); +is_deeply($info->{all_lines} , [$multi_line_named_start + 1, $multi_line_named_start + 2, $multi_line_named_end - 1], "got all lines"); + +$info = sub_info(\&multi_line_anon); +like($info->{name} , qr/__ANON__$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&multi_line_anon, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , $multi_line_anon_start, "got start line"); +is($info->{end_line} , $multi_line_anon_end, "got end line"); +is_deeply($info->{lines} , [$multi_line_anon_start, $multi_line_anon_end], "got lines"); +is_deeply($info->{all_lines} , [$multi_line_anon_start + 1, $multi_line_anon_start + 2, $multi_line_anon_end - 1], "got all lines"); + +$info = sub_info(\&multi_line_named, 1, 1000); +like($info->{name} , qr/multi_line_named$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&multi_line_named, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , 1, "got start line"); +is($info->{end_line} , 1000, "got end line"); +is_deeply($info->{lines} , [1, 1000], "got lines"); +is_deeply($info->{all_lines} , [1, $multi_line_named_start + 1, $multi_line_named_start + 2, $multi_line_named_end - 1, 1000], "got all lines"); + +$info = sub_info(\&multi_line_anon, 1000, 1); +like($info->{name} , qr/__ANON__$/, "Got name"); +is($info->{package} , __PACKAGE__, "got package"); +is($info->{file} , __FILE__, "got file"); +is($info->{ref} , \&multi_line_anon, "got ref"); +ok($info->{cobj}, "got cobj"); +is($info->{start_line} , 1, "got start line"); +is($info->{end_line} , 1000, "got end line"); +is_deeply($info->{lines} , [1, 1000], "got lines"); +is_deeply($info->{all_lines} , [1, $multi_line_anon_start + 1, $multi_line_anon_start + 2, $multi_line_anon_end - 1, 1000], "got all lines"); + +done_testing;