Syntax-Operator-Is-0.02000755001750001750 014643461713 13615 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/.editorconfig000444001750001750 5314643461713 16365 0ustar00leoleo000000000000root = true [*.{pm,pl,t}] indent_size = 3 Syntax-Operator-Is-0.02/Build.PL000444001750001750 170714643461713 15253 0ustar00leoleo000000000000use v5; use strict; use warnings; use Module::Build; use XS::Parse::Infix::Builder; use Data::Checks::Builder; my @extra_compiler_flags = qw( -Ihax ); my $build = Module::Build->new( module_name => "Syntax::Operator::Is", test_requires => { 'Test2::V0' => 0, }, configure_requires => { 'Module::Build' => '0.4004', # test_requires 'Data::Checks::Builder' => '0.06', 'XS::Parse::Infix::Builder' => '0.43', }, requires => { 'perl' => '5.014', # pluggable keywords, XOP 'Data::Checks' => '0.06', 'XS::Parse::Infix' => '0.43', }, license => 'perl', create_license => 1, create_readme => 1, meta_merge => { resources => { x_IRC => "irc://irc.perl.org/#io-async", }, }, extra_compiler_flags => \@extra_compiler_flags, ); XS::Parse::Infix::Builder->extend_module_build( $build ); Data::Checks::Builder->extend_module_build( $build ); $build->create_build_script; Syntax-Operator-Is-0.02/Changes000444001750001750 42014643461713 15221 0ustar00leoleo000000000000Revision history for Syntax-Operator-Is 0.02 2024-07-10 [CHANGES] * Account for and use the const-folding behaviour of constraint functions in Data::Checks v0.06 0.01 2024-07-08 First version, released on an unsuspecting world. Syntax-Operator-Is-0.02/LICENSE000444001750001750 4653414643461713 15013 0ustar00leoleo000000000000This software is copyright (c) 2024 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) 2024 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 Perl Artistic License 1.0 --- This software is Copyright (c) 2024 by Paul Evans . This is free software, licensed under: The Perl 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 as specified below. "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 uunet.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) give non-standard executables non-standard names, and clearly document 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. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded. 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 whoever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package. 7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. 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-Operator-Is-0.02/MANIFEST000444001750001750 34614643461713 15066 0ustar00leoleo000000000000.editorconfig Build.PL Changes hax/newOP_CUSTOM.c.inc lib/Syntax/Operator/Is.pm lib/Syntax/Operator/Is.xs LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/01is.t t/10inline-is.t t/80match-is.t t/99pod.t Syntax-Operator-Is-0.02/META.json000444001750001750 253714643461713 15402 0ustar00leoleo000000000000{ "abstract" : "match operator using L constraints", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4234", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Syntax-Operator-Is", "prereqs" : { "build" : { "requires" : { "ExtUtils::CBuilder" : "0" } }, "configure" : { "requires" : { "Data::Checks::Builder" : "0.06", "Module::Build" : "0.4004", "XS::Parse::Infix::Builder" : "0.43" } }, "runtime" : { "requires" : { "Data::Checks" : "0.06", "XS::Parse::Infix" : "0.43", "perl" : "5.014" } }, "test" : { "requires" : { "Test2::V0" : "0" } } }, "provides" : { "Syntax::Operator::Is" : { "file" : "lib/Syntax/Operator/Is.pm", "version" : "0.02" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ], "x_IRC" : "irc://irc.perl.org/#io-async" }, "version" : "0.02", "x_serialization_backend" : "JSON::PP version 4.16" } Syntax-Operator-Is-0.02/META.yml000444001750001750 152114643461713 15222 0ustar00leoleo000000000000--- abstract: 'match operator using L constraints' author: - 'Paul Evans ' build_requires: ExtUtils::CBuilder: '0' Test2::V0: '0' configure_requires: Data::Checks::Builder: '0.06' Module::Build: '0.4004' XS::Parse::Infix::Builder: '0.43' dynamic_config: 1 generated_by: 'Module::Build version 0.4234, 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-Operator-Is provides: Syntax::Operator::Is: file: lib/Syntax/Operator/Is.pm version: '0.02' requires: Data::Checks: '0.06' XS::Parse::Infix: '0.43' perl: '5.014' resources: IRC: irc://irc.perl.org/#io-async license: http://dev.perl.org/licenses/ version: '0.02' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Syntax-Operator-Is-0.02/README000444001750001750 572414643461713 14642 0ustar00leoleo000000000000NAME Syntax::Operator::Is - match operator using Data::Checks constraints SYNOPSIS On Perl v5.38 or later: use v5.38; use Syntax::Operator::Is; use Data::Checks qw( Num Object ); my $x = ...; if($x is Num) { say "x can be used as a number"; } elsif($x is Object) { say "x can be used as an object"; } Or via Syntax::Keyword::Match on Perl v5.14 or later: use v5.14; use Syntax::Operator::Is; use Syntax::Keyword::Match; use Data::Checks qw( Num Object ); my $x = ...; match($x : is) { case(Num) { say "x can be used as a number"; } case(Object) { say "x can be used as an object"; } } DESCRIPTION This module provides an infix operator that checks if a given value matches a value constraint provided by Data::Checks. Support for custom infix operators was added in the Perl 5.37.x development cycle and is available from development release v5.37.7 onwards, and therefore in Perl v5.38 onwards. The documentation of XS::Parse::Infix describes the situation in more detail. While Perl versions before this do not support custom infix operators, they can still be used via XS::Parse::Infix and hence XS::Parse::Keyword. Custom keywords which attempt to parse operator syntax may be able to use these. One such module is Syntax::Keyword::Match; see the SYNOPSIS example given above. Operator Name vs Test::More / Test2::V0 This module provides a named operator called is. The same name is used by both Test::More and Test2::V0 as a unit test assertion function. Since each has to be imported by request, this does not cause issues for code that does not try to use both of them at once. Most real use-cases will not be unit test scripts, and most unit test scripts will not need to use this operator. In situations where you need to use this is operator and one of the testing modules at the same time (for example, during a unit test of some check-related code), note that because of the way infix operator plugins work, the named operator will always take precedence and thus you will need to call the is() testing function by its fully-qualified name: use Test2::V0; use Syntax::Operator::Is; Test2::V0::is( 1 is Num, builtin::true, '1 is Num' ); Alternatively, use the ability of XS::Parse::Infix to import the operator with a different name and avoid the collision. use Test2::V0; use Syntax::Operator::Is is => { -as => "is_checked" }; is( 1 is_checked Num, builtin::true, '1 is Num' ); OPERATORS is my $ok = $value is $Constraint; Yields true if the given value is accepted by the given constraint checker. Yields false but should not otherwise throw an exception if the value is rejected. AUTHOR Paul Evans Syntax-Operator-Is-0.02/hax000755001750001750 014643461713 14375 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/hax/newOP_CUSTOM.c.inc000444001750001750 1035114643461713 17610 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 newUNOP_AUX_CUSTOM(func, flags, first, aux) S_newUNOP_AUX_CUSTOM(aTHX_ func, flags, first, aux) #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 newLISTOP_CUSTOM(func, flags, first, last) S_newLISTOP_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_newUNOP_AUX_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, OP *first, UNOP_AUX_item *aux) { UNOP_AUX *unop; #if HAVE_PERL_VERSION(5,22,0) unop = (UNOP_AUX *)newUNOP_AUX(OP_CUSTOM, flags, first, aux); #else croak("TODO: create newUNOP_AUX_CUSTOM"); #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_newLISTOP_CUSTOM(pTHX_ OP *(*func)(pTHX), U32 flags, OP *first, OP *last) { LISTOP *listop; #if HAVE_PERL_VERSION(5,22,0) listop = (LISTOP *)newLISTOP(OP_CUSTOM, flags, first, last); #else NewOp(1101, listop, 1, LISTOP); listop->op_type = (OPCODE)OP_CUSTOM; listop->op_first = first; if(first) first->op_sibling = last; listop->op_last = last; listop->op_flags = (U8)(flags | OPf_KIDS); if(last) listop->op_private = (U8)(2 | (flags >> 8)); else if(first) listop->op_private = (U8)(1 | (flags >> 8)); else listop->op_private = (U8)(flags >> 8); #endif listop->op_ppaddr = func; return (OP *)listop; } 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 = (U8)(1 | (flags >> 8)); /* 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-Operator-Is-0.02/lib000755001750001750 014643461713 14363 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/lib/Syntax000755001750001750 014643461713 15651 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/lib/Syntax/Operator000755001750001750 014643461713 17444 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/lib/Syntax/Operator/Is.pm000444001750001750 674014643461713 20521 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, 2024 -- leonerd@leonerd.org.uk package Syntax::Operator::Is 0.02; use v5.14; use warnings; use Carp; require XSLoader; XSLoader::load( __PACKAGE__, our $VERSION ); =head1 NAME C - match operator using L constraints =head1 SYNOPSIS On Perl v5.38 or later: use v5.38; use Syntax::Operator::Is; use Data::Checks qw( Num Object ); my $x = ...; if($x is Num) { say "x can be used as a number"; } elsif($x is Object) { say "x can be used as an object"; } Or via L on Perl v5.14 or later: use v5.14; use Syntax::Operator::Is; use Syntax::Keyword::Match; use Data::Checks qw( Num Object ); my $x = ...; match($x : is) { case(Num) { say "x can be used as a number"; } case(Object) { say "x can be used as an object"; } } =head1 DESCRIPTION This module provides an infix operator that checks if a given value matches a value constraint provided by L. Support for custom infix operators was added in the Perl 5.37.x development cycle and is available from development release v5.37.7 onwards, and therefore in Perl v5.38 onwards. The documentation of L describes the situation in more detail. While Perl versions before this do not support custom infix operators, they can still be used via C and hence L. Custom keywords which attempt to parse operator syntax may be able to use these. One such module is L; see the SYNOPSIS example given above. =head2 Operator Name vs C / C This module provides a named operator called C. The same name is used by both L and L as a unit test assertion function. Since each has to be imported by request, this does not cause issues for code that does not try to use both of them at once. Most real use-cases will not be unit test scripts, and most unit test scripts will not need to use this operator. In situations where you need to use this C operator and one of the testing modules at the same time (for example, during a unit test of some check-related code), note that because of the way infix operator plugins work, the named operator will always take precedence and thus you will need to call the C testing function by its fully-qualified name: use Test2::V0; use Syntax::Operator::Is; Test2::V0::is( 1 is Num, builtin::true, '1 is Num' ); Alternatively, use the ability of L to import the operator with a different name and avoid the collision. use Test2::V0; use Syntax::Operator::Is is => { -as => "is_checked" }; is( 1 is_checked Num, builtin::true, '1 is Num' ); =cut sub import { my $pkg = shift; $pkg->apply( 1, @_ ); } sub unimport { my $pkg = shift; $pkg->apply( 0, @_ ); } sub apply { my $pkg = shift; my ( $on, @syms ) = @_; @syms or @syms = qw( is ); $pkg->XS::Parse::Infix::apply_infix( $on, \@syms, qw( is ) ); croak "Unrecognised import symbols @syms" if @syms; } =head1 OPERATORS =head2 is my $ok = $value is $Constraint; Yields true if the given value is accepted by the given constraint checker. Yields false but should not otherwise throw an exception if the value is rejected. =cut =head1 AUTHOR Paul Evans =cut 0x55AA; Syntax-Operator-Is-0.02/lib/Syntax/Operator/Is.xs000444001750001750 450314643461713 20532 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, 2024 -- leonerd@leonerd.org.uk */ #define PERL_NO_GET_CONTEXT #include "EXTERN.h" #include "perl.h" #include "XSUB.h" #include "XSParseInfix.h" #include "DataChecks.h" #define HAVE_PERL_VERSION(R, V, S) \ (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S)))))) #include "newOP_CUSTOM.c.inc" /* Since Data::Checks v0.06, constraint functions are strongly const-folded so * it is likely that the RHS of an `is` operator is a constant expression. If * so, we'll compile it into a pp_static_is, an UNOP_AUX which stores the * actual `struct DataChecks_Checker` instance stored in the aux pointer */ static OP *pp_dynamic_is(pTHX) { dSP; SV *checkspec = POPs; SV *value = POPs; struct DataChecks_Checker *checker = make_checkdata(checkspec); PUSHs(boolSV(check_value(checker, value))); free_checkdata(checker); RETURN; } XOP xop_static_is; static OP *pp_static_is(pTHX) { dSP; SV *value = POPs; struct DataChecks_Checker *checker = (struct DataChecks_Checker *)cUNOP_AUX->op_aux; PUSHs(boolSV(check_value(checker, value))); RETURN; } static OP *new_is_op(pTHX_ U32 flags, OP *lhs, OP *rhs, SV **parsedata, void *hookdata) { if(rhs->op_type != OP_CONST) return newBINOP_CUSTOM(&pp_dynamic_is, flags, lhs, rhs); SV *checkspec = cSVOPx(rhs)->op_sv; struct DataChecks_Checker *checker = make_checkdata(checkspec); return newUNOP_AUX_CUSTOM(&pp_static_is, flags, lhs, (UNOP_AUX_item *)checker); } static const struct XSParseInfixHooks hooks_is = { .cls = XPI_CLS_MATCH_MISC, .permit_hintkey = "Syntax::Operator::Is/is", .new_op = &new_is_op, .ppaddr = &pp_dynamic_is, }; MODULE = Syntax::Operator::Is PACKAGE = Syntax::Operator::Is BOOT: boot_xs_parse_infix(0.43); boot_data_checks(0.06); /* const-folding */ register_xs_parse_infix("Syntax::Operator::Is::is", &hooks_is, NULL); XopENTRY_set(&xop_static_is, xop_name, "static_is"); XopENTRY_set(&xop_static_is, xop_desc, "is operator (with static constraint)"); XopENTRY_set(&xop_static_is, xop_class, OA_UNOP_AUX); Perl_custom_op_register(aTHX_ &pp_static_is, &xop_static_is); Syntax-Operator-Is-0.02/t000755001750001750 014643461713 14060 5ustar00leoleo000000000000Syntax-Operator-Is-0.02/t/00use.t000444001750001750 20214643461713 15310 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; require Syntax::Operator::Is; pass( "Modules loaded" ); done_testing; Syntax-Operator-Is-0.02/t/01is.t000444001750001750 110314643461713 15151 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Syntax::Operator::Is; BEGIN { plan skip_all => "No PL_infix_plugin" unless XS::Parse::Infix::HAVE_PL_INFIX_PLUGIN; } use Data::Checks qw( Num ); ok( 123 is Num, '123 is Num' ); ok( !( undef is Num ), 'undef is not Num' ); ok( !( "hello" is Num ), '"hello" is not Num' ); # Defeat const-folding to prove that pp_is_dynamic also works my $constraint_Num = Num; ok( 456 is $constraint_Num, '456 is Num via padsv' ); ok( !( undef is $constraint_Num ), 'undef is not Num via padsv' ); done_testing; Syntax-Operator-Is-0.02/t/10inline-is.t000444001750001750 241614643461713 16435 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Syntax::Operator::Is; BEGIN { plan skip_all => "No PL_infix_plugin" unless XS::Parse::Infix::HAVE_PL_INFIX_PLUGIN; } use Data::Checks qw( Num ); use B qw( svref_2object walkoptree ); sub count_ops { my ( $code ) = @_; my %opcounts; # B::walkoptree() is stupid # https://github.com/Perl/perl5/issues/19101 no warnings 'once'; local *B::OP::collect_opnames = sub { my ( $op ) = @_; $opcounts{ $op->name }++ unless $op->name eq "null"; }; walkoptree( svref_2object( $code )->ROOT, "collect_opnames" ); return %opcounts; } my %opcounts; # Const-folded op should use OP_STATIC_IS and no OP_ENTERSUB %opcounts = count_ops sub { $_[0] is Num }; ok( $opcounts{static_is}, 'LHS is Num uses OP_STATIC_IS' ); # Non-constfolded op should appear like a regular OP_PADSV + OP_INFIX_IS_... my $constraint_Num = Num; %opcounts = count_ops sub { $_[0] is $constraint_Num }; # We can't predict what the addr will be $opcounts{$_ =~ s/_0x[[:xdigit:]]+$/_ADDR/r} = delete $opcounts{$_} for grep { m/_0x[[:xdigit:]]+$/ } keys %opcounts; ok( $opcounts{infix_Syntax__Operator__Is__is_ADDR}, 'LHS is $padsv uses OP_IS (dynamic)' ); ok( $opcounts{padsv}, 'LHS is $padsv uses OP_PADSV' ); done_testing; Syntax-Operator-Is-0.02/t/80match-is.t000444001750001750 227114643461713 16261 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; BEGIN { plan skip_all => "Syntax::Keyword::Match >= 0.08 is not available" unless eval { require Syntax::Keyword::Match; Syntax::Keyword::Match->VERSION( '0.08' ); }; plan skip_all => "Syntax::Operator::Is is not available" unless eval { require Syntax::Operator::Is }; Syntax::Keyword::Match->import; Syntax::Operator::Is->import; diag( "Syntax::Keyword::Match $Syntax::Keyword::Match::VERSION, " . "Syntax::Operator::Is $Syntax::Operator::Is::VERSION" ); } # if we have Syntax::Operator::Is available then we know we must have # Data::Checks as well use Data::Checks qw( Num Object ); { sub func { match( $_[0] : is ) { case( Num ) { return "arg is a number" } case( Object ) { return "arg is an object" } default { return "arg is neither" } } } Test2::V0::is( func( 123 ), "arg is a number", 'func() on number' ); Test2::V0::is( func( bless [], "SomeClass" ), "arg is an object", 'func() on object' ); Test2::V0::is( func( [] ), "arg is neither", 'func() on arrayref' ); } done_testing; Syntax-Operator-Is-0.02/t/99pod.t000444001750001750 25514643461713 15330 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();