Syntax-Keyword-MultiSub-0.04000755001750001750 014453746234 14644 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/.editorconfig000444001750001750 5314453746234 17414 0ustar00leoleo000000000000root = true [*.{pm,pl,t}] indent_size = 3 Syntax-Keyword-MultiSub-0.04/Build.PL000444001750001750 141514453746234 16276 0ustar00leoleo000000000000use v5; use strict; use warnings; use Module::Build; use XS::Parse::Sublike::Builder; my $build = Module::Build->new( module_name => "Syntax::Keyword::MultiSub", requires => { 'perl' => '5.026', # parse_subsignature() 'XS::Parse::Sublike' => '0.15', }, test_requires => { 'Test2::V0' => 0, }, configure_requires => { 'Module::Build' => '0.4004', # test_requires 'XS::Parse::Sublike::Builder' => '0.15', }, extra_compiler_flags => [qw( -I. -Ihax -ggdb )], license => 'perl', create_license => 1, create_readme => 1, meta_merge => { resources => { x_IRC => "irc://irc.perl.org/#io-async", }, }, ); XS::Parse::Sublike::Builder->extend_module_build( $build ); $build->create_build_script; Syntax-Keyword-MultiSub-0.04/Changes000444001750001750 140214453746234 16271 0ustar00leoleo000000000000Revision history for Syntax-Keyword-MultiSub 0.04 2023-07-13 [CHANGES] * Updates to compile cleanly on perl v5.38 * Remember to implement `no Syntax::Keyword::MultiSub` to disable the syntax 0.03 2023-06-05 [CHANGES] * Swap all the unit tests to `Test2::V0` [BUGFIXES] * Also handle OP_DBSTATE when running under `perl -d` 0.02 2021-12-16 [CHANGES] * Updated to XS::Parse::Sublike 0.15 + Use ctx->moddata as storage + Use dynamic actions to simplify name fiddling * Added cross-module integration test t/80async-multi-sub.t from Future-AsyncAwait 0.01 2021-10-28 First version, released on an unsuspecting world. Syntax-Keyword-MultiSub-0.04/LICENSE000444001750001750 4375514453746234 16044 0ustar00leoleo000000000000This software is copyright (c) 2023 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) 2023 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) 2023 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Syntax-Keyword-MultiSub-0.04/MANIFEST000444001750001750 40414453746234 16110 0ustar00leoleo000000000000.editorconfig Build.PL Changes hax/newOP_CUSTOM.c.inc hax/perl-backcompat.c.inc lib/Syntax/Keyword/MultiSub.pm lib/Syntax/Keyword/MultiSub.xs LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/01multi.t t/80async-multi-sub.t t/99pod.t Syntax-Keyword-MultiSub-0.04/META.json000444001750001750 241714453746234 16426 0ustar00leoleo000000000000{ "abstract" : "multiple dispatch on subroutines", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4231", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Syntax-Keyword-MultiSub", "prereqs" : { "build" : { "requires" : { "ExtUtils::CBuilder" : "0" } }, "configure" : { "requires" : { "Module::Build" : "0.4004", "XS::Parse::Sublike::Builder" : "0.15" } }, "runtime" : { "requires" : { "XS::Parse::Sublike" : "0.15", "perl" : "5.026" } }, "test" : { "requires" : { "Test2::V0" : "0" } } }, "provides" : { "Syntax::Keyword::MultiSub" : { "file" : "lib/Syntax/Keyword/MultiSub.pm", "version" : "0.04" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ], "x_IRC" : "irc://irc.perl.org/#io-async" }, "version" : "0.04", "x_serialization_backend" : "JSON::PP version 4.07" } Syntax-Keyword-MultiSub-0.04/META.yml000444001750001750 143514453746234 16255 0ustar00leoleo000000000000--- abstract: 'multiple dispatch on subroutines' author: - 'Paul Evans ' build_requires: ExtUtils::CBuilder: '0' Test2::V0: '0' configure_requires: Module::Build: '0.4004' XS::Parse::Sublike::Builder: '0.15' dynamic_config: 1 generated_by: 'Module::Build version 0.4231, 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: Syntax-Keyword-MultiSub provides: Syntax::Keyword::MultiSub: file: lib/Syntax/Keyword/MultiSub.pm version: '0.04' requires: XS::Parse::Sublike: '0.15' perl: '5.026' resources: IRC: irc://irc.perl.org/#io-async license: http://dev.perl.org/licenses/ version: '0.04' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Syntax-Keyword-MultiSub-0.04/README000444001750001750 646214453746234 15671 0ustar00leoleo000000000000NAME Syntax::Keyword::MultiSub - multiple dispatch on subroutines SYNOPSIS use v5.26; use Syntax::Keyword::MultiSub; use experimental 'signatures'; multi sub max() { return undef; } multi sub max($x) { return $x; } multi sub max($x, @more) { my $y = max(@more); return $x > $y ? $x : $y; } say max(1, 2, 15, 3, 4); # prints 15 DESCRIPTION This module provides a new keyword, multi, to put before subroutine declarations, which permits multiple distinct function bodies to be provided, which take different parameters. A call to a multi sub will invoke whichever function body best fits the arguments passed. Currently this module can only make dispatching decisions based on the number of arguments as compared to the number of signature parameters each body was expecting. It requires perl version 5.26 or above, in order to get enough support from signatures. Note also enabling this module does not enable the signatures feature; you must do that independently. KEYWORDS multi multi sub NAME (SIGNATURE) { BODY... } Declares an alternative for the multi sub of the given name. Each alternative will be distinguished by the number of parameters its signature declares. If the signature includes optional parameters, this alternative is considered to cover the entire range from none to all of the optional ones being present. The ranges of parameter count covered by every alternative to a given function name must be non-overlapping; it is a compiletime error for two function bodies to claim the same number of parameters. Each of the non-final alternatives for any given name must use only scalar parameters (though some may be optional); but as a special-case, the final alternative may end in a slurpy parameter (either an array or a hash). If this is the case then it will be considered for dispatch if none of the previous alternatives match, as long as it has at least the minimum number of required parameters present. WITH OTHER MODULES Future::AsyncAwait As of Future::AsyncAwait version 0.55 a cross-module integration test asserts that the multi modifier can be applied to async sub. use Future::AsyncAwait; use Syntax::Keyword::MultiSub; async multi sub f () { return "nothing"; } async multi sub f ($key) { return await get_thing($key); } TODO * Much better error checking and diagnostics for function bodies that don't use signatures. * Cross-module testing with Object::Pad (for multi method). This may require a better combined implementation, to be aware of method resolution order, inheritence, etc... * An eventual consideration of type assertions or value testing, as well as simple argument count. This particular task is likely to be a large undertaking as it spans several other areas of language. As well as types on parameters, it would be nice to put them on lexical variables, object slots, match/case comparisons, and so on. It would be a shame to invent a special mechanism for one of these areas that could not be reüsed by the others. AUTHOR Paul Evans Syntax-Keyword-MultiSub-0.04/hax000755001750001750 014453746234 15424 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/hax/newOP_CUSTOM.c.inc000444001750001750 612414453746234 20622 0ustar00leoleo000000000000/* vi: set ft=c : */ /* Before perl 5.22 under -DDEBUGGING, various new*OP() functions throw assert * failures on OP_CUSTOM. * https://rt.cpan.org/Ticket/Display.html?id=128562 */ #define newOP_CUSTOM(func, flags) S_newOP_CUSTOM(aTHX_ func, flags) #define newUNOP_CUSTOM(func, flags, first) S_newUNOP_CUSTOM(aTHX_ func, flags, first) #define newSVOP_CUSTOM(func, flags, sv) S_newSVOP_CUSTOM(aTHX_ func, flags, sv) #define newBINOP_CUSTOM(func, flags, first, last) S_newBINOP_CUSTOM(aTHX_ func, flags, first, last) #define newLOGOP_CUSTOM(func, flags, first, other) S_newLOGOP_CUSTOM(aTHX_ func, flags, first, other) static OP *S_newOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags) { OP *op = newOP(OP_CUSTOM, flags); op->op_ppaddr = func; return op; } static OP *S_newUNOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, OP *first) { UNOP *unop; #if HAVE_PERL_VERSION(5,22,0) unop = (UNOP *)newUNOP(OP_CUSTOM, flags, first); #else NewOp(1101, unop, 1, UNOP); unop->op_type = (OPCODE)OP_CUSTOM; unop->op_first = first; unop->op_flags = (U8)(flags | OPf_KIDS); unop->op_private = (U8)(1 | (flags >> 8)); #endif unop->op_ppaddr = func; return (OP *)unop; } static OP *S_newSVOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, SV *sv) { SVOP *svop; #if HAVE_PERL_VERSION(5,22,0) svop = (SVOP *)newSVOP(OP_CUSTOM, flags, sv); #else NewOp(1101, svop, 1, SVOP); svop->op_type = (OPCODE)OP_CUSTOM; svop->op_sv = sv; svop->op_next = (OP *)svop; svop->op_flags = 0; svop->op_private = 0; #endif svop->op_ppaddr = func; return (OP *)svop; } static OP *S_newBINOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, OP *first, OP *last) { BINOP *binop; #if HAVE_PERL_VERSION(5,22,0) binop = (BINOP *)newBINOP(OP_CUSTOM, flags, first, last); #else NewOp(1101, binop, 1, BINOP); binop->op_type = (OPCODE)OP_CUSTOM; binop->op_first = first; first->op_sibling = last; binop->op_last = last; binop->op_flags = (U8)(flags | OPf_KIDS); binop->op_private = (U8)(2 | (flags >> 8)); #endif binop->op_ppaddr = func; return (OP *)binop; } static OP *S_newLOGOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, OP *first, OP *other) { OP *o; #if HAVE_PERL_VERSION(5,22,0) o = newLOGOP(OP_CUSTOM, flags, first, other); #else /* Parts of this code copypasted from perl 5.20.0's op.c S_new_logop() */ LOGOP *logop; first = op_contextualize(first, G_SCALAR); NewOp(1101, logop, 1, LOGOP); logop->op_type = (OPCODE)OP_CUSTOM; logop->op_ppaddr = NULL; /* Because caller only overrides it anyway */ logop->op_first = first; logop->op_flags = (U8)(flags | OPf_KIDS); logop->op_other = LINKLIST(other); /* logop->op_private has nothing interesting for OP_CUSTOM */ /* Link in postfix order */ logop->op_next = LINKLIST(first); first->op_next = (OP *)logop; first->op_sibling = other; /* No CHECKOP for OP_CUSTOM */ o = newUNOP(OP_NULL, 0, (OP *)logop); other->op_next = o; #endif /* the returned op is actually an UNOP that's either NULL or NOT; the real * logop is the op_next of it */ cUNOPx(o)->op_first->op_ppaddr = func; return o; } Syntax-Keyword-MultiSub-0.04/hax/perl-backcompat.c.inc000444001750001750 1361614453746234 21570 0ustar00leoleo000000000000/* vi: set ft=c : */ #define HAVE_PERL_VERSION(R, V, S) \ (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S)))))) #ifndef NOT_REACHED # define NOT_REACHED assert(0) #endif #ifndef SvTRUE_NN # define SvTRUE_NN(sv) SvTRUE(sv) #endif #ifndef G_LIST # define G_LIST G_ARRAY #endif #if !HAVE_PERL_VERSION(5, 18, 0) typedef AV PADNAMELIST; # define PadlistARRAY(pl) ((PAD **)AvARRAY(pl)) # define PadlistNAMES(pl) (*PadlistARRAY(pl)) typedef SV PADNAME; # define PadnamePV(pn) (SvPOKp(pn) ? SvPVX(pn) : NULL) # define PadnameLEN(pn) SvCUR(pn) # define PadnameIsSTATE(pn) (!!SvPAD_STATE(pn)) # define PadnameOUTER(pn) (SvFAKE(pn) && !SvPAD_STATE(pn)) # define PadnamelistARRAY(pnl) AvARRAY(pnl) # define PadnamelistMAX(pnl) AvFILLp(pnl) # define PadARRAY(p) AvARRAY(p) # define PadMAX(pad) AvFILLp(pad) #endif #if !HAVE_PERL_VERSION(5, 22, 0) # define CvPADLIST_set(cv, padlist) (CvPADLIST(cv) = padlist) # define newPADNAMEpvn(p,n) S_newPADNAMEpvn(aTHX_ p,n) static PADNAME *S_newPADNAMEpvn(pTHX_ const char *pv, STRLEN n) { PADNAME *pn = newSVpvn(pv, n); /* PADNAMEs need to be at least SVt_PVNV in order to store the COP_SEQ_* * fields */ sv_upgrade(pn, SVt_PVNV); return pn; } # define PadnameREFCNT_dec(pn) SvREFCNT_dec(pn) #endif #ifndef av_count # define av_count(av) (AvFILL(av) + 1) #endif #ifndef av_top_index # define av_top_index(av) AvFILL(av) #endif #ifndef block_end # define block_end(a,b) Perl_block_end(aTHX_ a,b) #endif #ifndef block_start # define block_start(a) Perl_block_start(aTHX_ a) #endif #ifndef cophh_exists_pvs # define cophh_exists_pvs(a,b,c) cBOOL(cophh_fetch_pvs(a,b,c)) #endif #ifndef cv_clone # define cv_clone(a) Perl_cv_clone(aTHX_ a) #endif #ifndef intro_my # define intro_my() Perl_intro_my(aTHX) #endif #ifndef pad_alloc # define pad_alloc(a,b) Perl_pad_alloc(aTHX_ a,b) #endif #ifndef CX_CUR # define CX_CUR() (&cxstack[cxstack_ix]) #endif #if HAVE_PERL_VERSION(5, 24, 0) # define OLDSAVEIX(cx) (cx->blk_oldsaveix) #else # define OLDSAVEIX(cx) (PL_scopestack[cx->blk_oldscopesp-1]) #endif #ifndef OpSIBLING # define OpSIBLING(op) ((op)->op_sibling) #endif #ifndef OpHAS_SIBLING # define OpHAS_SIBLING(op) (cBOOL(OpSIBLING(op))) #endif #ifndef OpMORESIB_set # define OpMORESIB_set(op,sib) ((op)->op_sibling = (sib)) #endif #ifndef OpLASTSIB_set /* older perls don't need to store this at all */ # define OpLASTSIB_set(op,parent) #endif #ifndef op_convert_list # define op_convert_list(type, flags, o) S_op_convert_list(aTHX_ type, flags, o) static OP *S_op_convert_list(pTHX_ I32 type, I32 flags, OP *o) { /* A minimal recreation just for our purposes */ assert( /* A hardcoded list of the optypes we know this will work for */ type == OP_ENTERSUB || type == OP_JOIN || type == OP_PUSH || 0); o->op_type = type; o->op_flags |= flags; o->op_ppaddr = PL_ppaddr[type]; o = PL_check[type](aTHX_ o); /* op_std_init() */ if(PL_opargs[type] & OA_RETSCALAR) o = op_contextualize(o, G_SCALAR); if(PL_opargs[type] & OA_TARGET && !o->op_targ) o->op_targ = pad_alloc(type, SVs_PADTMP); return o; } #endif #ifndef newMETHOP_named # define newMETHOP_named(type, flags, name) newSVOP(type, flags, name) #endif #ifndef PARENT_PAD_INDEX_set # if HAVE_PERL_VERSION(5, 22, 0) # define PARENT_PAD_INDEX_set(pn,val) (PARENT_PAD_INDEX(pn) = val) # else /* stolen from perl-5.20.0's pad.c */ # define PARENT_PAD_INDEX_set(sv,val) \ STMT_START { ((XPVNV*)SvANY(sv))->xnv_u.xpad_cop_seq.xlow = (val); } STMT_END # endif #endif /* On Perl 5.14 this had a different name */ #ifndef pad_add_name_pvn #define pad_add_name_pvn(name, len, flags, typestash, ourstash) MY_pad_add_name(aTHX_ name, len, flags, typestash, ourstash) static PADOFFSET MY_pad_add_name(pTHX_ const char *name, STRLEN len, U32 flags, HV *typestash, HV *ourstash) { /* perl 5.14's Perl_pad_add_name requires a NUL-terminated name */ SV *namesv = sv_2mortal(newSVpvn(name, len)); return Perl_pad_add_name(aTHX_ SvPV_nolen(namesv), SvCUR(namesv), flags, typestash, ourstash); } #endif #if !HAVE_PERL_VERSION(5, 26, 0) # define isIDFIRST_utf8_safe(s, e) (PERL_UNUSED_ARG(e), isIDFIRST_utf8(s)) # define isIDCONT_utf8_safe(s, e) (PERL_UNUSED_ARG(e), isIDCONT_utf8(s)) #endif #ifndef CXp_EVALBLOCK /* before perl 5.34 this was called CXp_TRYBLOCK */ # define CXp_EVALBLOCK CXp_TRYBLOCK #endif #if !HAVE_PERL_VERSION(5, 26, 0) # define sv_set_undef(sv) sv_setsv(sv, &PL_sv_undef) #endif #ifndef newAVav # define newAVav(av) S_newAVav(aTHX_ av) static AV *S_newAVav(pTHX_ AV *av) { AV *ret = newAV(); U32 count = av_count(av); U32 i; for(i = 0; i < count; i++) av_push(ret, newSVsv(AvARRAY(av)[i])); return ret; } #endif #if !defined(sv_derived_from_hv) && HAVE_PERL_VERSION(5, 16, 0) # define sv_derived_from_hv(sv, hv) MY_sv_derived_from_hv(aTHX_ sv, hv) static bool MY_sv_derived_from_hv(pTHX_ SV *sv, HV *hv) { char *hvname = HvNAME(hv); if(!hvname) return FALSE; return sv_derived_from_pvn(sv, hvname, HvNAMELEN(hv), HvNAMEUTF8(hv) ? SVf_UTF8 : 0); } #endif #ifndef xV_FROM_REF # ifdef PERL_USE_GCC_BRACE_GROUPS # define xV_FROM_REF(XV, ref) \ ({ SV *_ref = ref; assert(SvROK(_ref)); assert(SvTYPE(SvRV(_ref)) == SVt_PV ## XV); (XV *)(SvRV(_ref)); }) # else # define xV_FROM_REF(XV, ref) ((XV *)SvRV(ref)) # endif # define AV_FROM_REF(ref) xV_FROM_REF(AV, ref) # define CV_FROM_REF(ref) xV_FROM_REF(CV, ref) # define HV_FROM_REF(ref) xV_FROM_REF(HV, ref) #endif #ifndef newPADxVOP # define newPADxVOP(type, flags, padix) S_newPADxVOP(aTHX_ type, flags, padix) static OP *S_newPADxVOP(pTHX_ I32 type, I32 flags, PADOFFSET padix) { OP *op = newOP(type, flags); op->op_targ = padix; return op; } #endif Syntax-Keyword-MultiSub-0.04/lib000755001750001750 014453746234 15412 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/lib/Syntax000755001750001750 014453746234 16700 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/lib/Syntax/Keyword000755001750001750 014453746234 20324 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/lib/Syntax/Keyword/MultiSub.pm000444001750001750 1017114453746234 22603 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, 2021-2023 -- leonerd@leonerd.org.uk package Syntax::Keyword::MultiSub 0.04; use v5.14; use warnings; use Carp; require XSLoader; XSLoader::load( __PACKAGE__, our $VERSION ); =encoding UTF-8 =head1 NAME C - multiple dispatch on subroutines =head1 SYNOPSIS use v5.26; use Syntax::Keyword::MultiSub; use experimental 'signatures'; multi sub max() { return undef; } multi sub max($x) { return $x; } multi sub max($x, @more) { my $y = max(@more); return $x > $y ? $x : $y; } say max(1, 2, 15, 3, 4); # prints 15 =head1 DESCRIPTION This module provides a new keyword, C, to put before subroutine declarations, which permits multiple distinct function bodies to be provided, which take different parameters. A call to a C will invoke whichever function body best fits the arguments passed. Currently this module can only make dispatching decisions based on the number of arguments as compared to the number of signature parameters each body was expecting. It requires F version 5.26 or above, in order to get enough support from signatures. Note also enabling this module does not enable the C feature; you must do that independently. =cut =head1 KEYWORDS =head2 multi multi sub NAME (SIGNATURE) { BODY... } Declares an alternative for the C of the given name. Each alternative will be distinguished by the number of parameters its signature declares. If the signature includes optional parameters, this alternative is considered to cover the entire range from none to all of the optional ones being present. The ranges of parameter count covered by every alternative to a given function name must be non-overlapping; it is a compiletime error for two function bodies to claim the same number of parameters. Each of the non-final alternatives for any given name must use only scalar parameters (though some may be optional); but as a special-case, the final alternative may end in a slurpy parameter (either an array or a hash). If this is the case then it will be considered for dispatch if none of the previous alternatives match, as long as it has at least the minimum number of required parameters present. =cut sub import { my $pkg = shift; my $caller = caller; $pkg->import_into( $caller, @_ ); } sub unimport { my $pkg = shift; my $caller = caller; $pkg->unimport_into( $caller, @_ ); } sub import_into { shift->apply( sub { $^H{ $_[0] }++ }, @_ ) } sub unimport_into { shift->apply( sub { delete $^H{ $_[0] } }, @_ ) } sub apply { my $pkg = shift; my ( $cb, $caller, @syms ) = @_; my %syms = map { $_ => 1 } @syms; $cb->( "Syntax::Keyword::MultiSub/multi" ); croak "Unrecognised import symbols @{[ keys %syms ]}" if keys %syms; } =head1 WITH OTHER MODULES =head2 Future::AsyncAwait As of L version 0.55 a cross-module integration test asserts that the C modifier can be applied to C. use Future::AsyncAwait; use Syntax::Keyword::MultiSub; async multi sub f () { return "nothing"; } async multi sub f ($key) { return await get_thing($key); } =head1 TODO =over 4 =item * Much better error checking and diagnostics for function bodies that don't use signatures. =item * Cross-module testing with L (for C). This may require a better combined implementation, to be aware of method resolution order, inheritence, etc... =item * An eventual consideration of type assertions or value testing, as well as simple argument count. This particular task is likely to be a large undertaking as it spans several other areas of language. As well as types on parameters, it would be nice to put them on lexical variables, object slots, C comparisons, and so on. It would be a shame to invent a special mechanism for one of these areas that could not be reüsed by the others. =back =cut =head1 AUTHOR Paul Evans =cut 0x55AA; Syntax-Keyword-MultiSub-0.04/lib/Syntax/Keyword/MultiSub.xs000444001750001750 1316114453746234 22623 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, 2021 -- leonerd@leonerd.org.uk */ #include "EXTERN.h" #include "perl.h" #include "XSUB.h" #include "XSParseSublike.h" #include "perl-backcompat.c.inc" #include "newOP_CUSTOM.c.inc" struct MultiSubOption { int args_min, args_max; CV *cv; }; #define get_optionsav(cv, padix) S_get_optionsav(aTHX_ cv, padix) static AV *S_get_optionsav(pTHX_ CV *cv, PADOFFSET padix) { PADLIST *pl = CvPADLIST(cv); AV *optionsav = (AV *)PadARRAY(PadlistARRAY(pl)[1])[padix]; return optionsav; } static OP *pp_dispatch_multisub(pTHX) { IV nargs = av_count(GvAV(PL_defgv)); CV *runcv = find_runcv(0); AV *optionsav = get_optionsav(runcv, PL_op->op_targ); CV *jumpcv = NULL; IV noptions = av_count(optionsav); IV optioni; for(optioni = 0; optioni < noptions; optioni++) { struct MultiSubOption *option = (struct MultiSubOption *)AvARRAY(optionsav)[optioni]; if(nargs < option->args_min) continue; if(option->args_max > -1 && nargs > option->args_max) continue; jumpcv = option->cv; break; } if(!jumpcv) croak("Unable to find a function body for a call to &%s::%s having %d arguments", HvNAME(CvSTASH(runcv)), GvNAME(CvGV(runcv)), nargs); /* Now pretend to be goto &$cv * Reuse the same PL_op structure and just call that ppfunc */ assert(PL_op->op_flags & OPf_STACKED); dSP; mPUSHs(newRV_inc((SV *)jumpcv)); PUTBACK; assert(SvROK(TOPs) && SvTYPE(SvRV(TOPs)) == SVt_PVCV); return (PL_ppaddr[OP_GOTO])(aTHX); } /* XSParseSublikeContext moddata keys */ #define MODDATA_KEY_NAME "Syntax::Keyword::MultiSub/name" #define MODDATA_KEY_COMPMULTICV "Syntax::Keyword::MultiSub/compmulticv" static void parse_pre_subparse(pTHX_ struct XSParseSublikeContext *ctx, void *hookdata) { SV *name = ctx->name; CV *multicv = get_cvn_flags(SvPVX(name), SvCUR(name), SvUTF8(name) ? SVf_UTF8 : 0); if(!multicv) { ENTER; I32 floor_ix = start_subparse(FALSE, 0); SAVEFREESV(PL_compcv); I32 save_ix = block_start(TRUE); PADOFFSET padix = pad_add_name_pvs("@(Syntax::Keyword::MultiSub/options)", 0, NULL, NULL); intro_my(); OP *dispatchop = newOP_CUSTOM(&pp_dispatch_multisub, OPf_STACKED); dispatchop->op_targ = padix; OP *body = block_end(save_ix, dispatchop); SvREFCNT_inc(PL_compcv); multicv = newATTRSUB(floor_ix, newSVOP(OP_CONST, 0, SvREFCNT_inc(name)), NULL, NULL, body); LEAVE; } hv_stores(ctx->moddata, MODDATA_KEY_NAME, SvREFCNT_inc(name)); hv_stores(ctx->moddata, MODDATA_KEY_COMPMULTICV, SvREFCNT_inc(multicv)); /* Do not let this sub be installed as a named symbol */ ctx->actions &= ~XS_PARSE_SUBLIKE_ACTION_INSTALL_SYMBOL; } static void parse_post_newcv(pTHX_ struct XSParseSublikeContext *ctx, void *hookdata) { CV *cv = ctx->cv; if(!cv) return; SV *name = *hv_fetchs(ctx->moddata, MODDATA_KEY_NAME, 0); CV *multicv = (CV *)*hv_fetchs(ctx->moddata, MODDATA_KEY_COMPMULTICV, 0); PADNAMELIST *pln = PadlistNAMES(CvPADLIST(multicv)); /* We can't use pad_findmy_pvn() because it gets upset about seqnums */ PADOFFSET padix; for(padix = 1; padix <= PadnamelistMAX(pln); padix++) if(strEQ(PadnamePV(PadnamelistARRAY(pln)[padix]), "@(Syntax::Keyword::MultiSub/options)")) break; assert(padix <= PadnamelistMAX(pln)); AV *optionsav = get_optionsav(multicv, padix); bool final_is_slurpy = av_count(optionsav) && (((struct MultiSubOption *)AvARRAY(optionsav)[AvFILL(optionsav)])->args_max == -1); int args_min, args_max; OP *o = CvSTART(cv); while(o) { redo: switch(o->op_type) { case OP_NEXTSTATE: case OP_DBSTATE: o = o->op_next; goto redo; case OP_ARGCHECK: { #if HAVE_PERL_VERSION(5, 31, 5) struct op_argcheck_aux *aux = (struct op_argcheck_aux *)cUNOP_AUXo->op_aux; char slurpy = aux->slurpy; args_max = aux->params; args_min = args_max - aux->opt_params; #else UNOP_AUX_item *aux = cUNOP_AUXo->op_aux; char slurpy = aux[2].iv; args_max = aux[0].iv; args_min = args_max - aux[1].iv; #endif if(slurpy) { if(final_is_slurpy) croak("Already have a slurpy function body for multi sub %" SVf, name); args_max = -1; } goto done; } default: croak("TODO: Unsure how to find argcheck op within %s", PL_op_name[o->op_type]); } } done: ; IV noptions = av_count(optionsav); IV optioni; for(optioni = 0; optioni < noptions; optioni++) { struct MultiSubOption *option = (struct MultiSubOption *)AvARRAY(optionsav)[optioni]; if(option->args_max == -1 || args_min > option->args_max) continue; if(args_max < option->args_min) continue; croak("Ambiguous argument count for multi sub %" SVf, name); } struct MultiSubOption *option; Newx(option, 1, struct MultiSubOption); option->args_min = args_min; option->args_max = args_max; option->cv = cv_clone(cv); /* Because it is currently a protosub */ av_push(optionsav, (SV *)option); } static struct XSParseSublikeHooks hooks_multi = { .permit_hintkey = "Syntax::Keyword::MultiSub/multi", .flags = XS_PARSE_SUBLIKE_FLAG_PREFIX|XS_PARSE_SUBLIKE_COMPAT_FLAG_DYNAMIC_ACTIONS, .require_parts = XS_PARSE_SUBLIKE_PART_NAME, .pre_subparse = parse_pre_subparse, .post_newcv = parse_post_newcv, }; MODULE = Syntax::Keyword::MultiSub PACKAGE = Syntax::Keyword::MultiSub BOOT: boot_xs_parse_sublike(0.15); register_xs_parse_sublike("multi", &hooks_multi, NULL); Syntax-Keyword-MultiSub-0.04/t000755001750001750 014453746234 15107 5ustar00leoleo000000000000Syntax-Keyword-MultiSub-0.04/t/00use.t000444001750001750 20414453746234 16341 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; require Syntax::Keyword::MultiSub; pass "Modules loaded"; done_testing; Syntax-Keyword-MultiSub-0.04/t/01multi.t000444001750001750 240314453746234 16723 0ustar00leoleo000000000000#!/usr/bin/perl use v5.26; use warnings; use experimental 'signatures'; use Test2::V0; use Syntax::Keyword::MultiSub; { multi sub f () { return "" } multi sub f ($x) { return "" } multi sub f ($x, $y) { return "" } is( f(), "", 'f() zero args' ); is( f("a"), "", 'f() one arg' ); is( f("b", "c"), "", 'f() two args' ); like( dies { f("too", "many", "args") }, qr/^Unable to find a function body for a call to &main::f having 3 arguments at /, 'f() complains with too many args' ); } { multi sub g () { return "zero"; } multi sub g ($x, $y = 123) { return "one-or-two($x,$y)"; } is( g("x"), "one-or-two(x,123)", 'g() one arg' ); is( g("x", "y"), "one-or-two(x,y)", 'g() two args' ); } { multi sub h ($one) { return "unary($one)" } multi sub h (@rest) { return "slurpy(@rest)" } is( h(1), "unary(1)", 'h() one arg' ); is( h(2,3,4), "slurpy(2 3 4)", 'h() three args' ); is( h(), "slurpy()", 'h() zero args' ); } { no Syntax::Keyword::MultiSub; sub multi { return "normal function" } is( multi, "normal function", 'multi() parses as a normal function call' ); } done_testing; Syntax-Keyword-MultiSub-0.04/t/80async-multi-sub.t000444001750001750 237014453746234 20637 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; BEGIN { plan skip_all => "signatures are not availble" unless $] >= 5.026; } use feature 'signatures'; no warnings 'experimental::signatures'; BEGIN { plan skip_all => "Future is not available" unless eval { require Future }; plan skip_all => "Future::AsyncAwait >= 0.55 is not available" unless eval { require Future::AsyncAwait; Future::AsyncAwait->VERSION( '0.55' ) }; plan skip_all => "Syntax::Keyword::MultiSub >= 0.01 is not available" unless eval { require Syntax::Keyword::MultiSub; Syntax::Keyword::MultiSub->VERSION( '0.01' ) }; Future::AsyncAwait->import; Syntax::Keyword::MultiSub->import; diag( "Future::AsyncAwait $Future::AsyncAwait::VERSION, " . "Syntax::Keyword::MultiSub $Syntax::Keyword::MultiSub::VERSION" ); } async multi sub f () { return "null"; } async multi sub f ( $x ) { return "un($x)"; } is( await f(), "null", 'f() on zero args' ); is( await f( 1 ), "un(1)", 'f() on one arg' ); # Ordering shouldn't matter multi async sub g () { return "also-null"; } multi async sub g ( $x ) { return "also-un($x)"; } is( await g(), "also-null", 'g() on zero args' ); done_testing; Syntax-Keyword-MultiSub-0.04/t/99pod.t000444001750001750 25514453746234 16357 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok();