Feature-Compat-Class-0.07000755001750001750 014642762622 14053 5ustar00leoleo000000000000Feature-Compat-Class-0.07/.editorconfig000444001750001750 5314642762622 16623 0ustar00leoleo000000000000root = true [*.{pm,pl,t}] indent_size = 3 Feature-Compat-Class-0.07/Build.PL000444001750001750 135414642762622 15507 0ustar00leoleo000000000000use v5; use strict; use warnings; use Module::Build; my %REQUIRES_PERL = ( ); my %REQUIRES_OP = ( 'Object::Pad' => '0.806', ); # We need the :reader attribute from 5.40 my $HAVE_FEATURE_CLASS = $^V ge v5.40; printf "Using %s\n", $HAVE_FEATURE_CLASS ? "core's feature 'class'" : "Object::Pad"; my $build = Module::Build->new( module_name => 'Feature::Compat::Class', requires => { 'perl' => '5.014', $HAVE_FEATURE_CLASS ? %REQUIRES_PERL : %REQUIRES_OP, }, test_requires => { 'Test::More' => '0.88', # done_testing }, configure_requires => { 'Module::Build' => '0.4004', # test_requires }, license => 'perl', create_license => 1, create_readme => 1, ); $build->create_build_script; Feature-Compat-Class-0.07/Changes000444001750001750 250114642762622 15501 0ustar00leoleo000000000000Revision history for Feature-Compat-Class 0.07 2024-07-08 [CHANGES] * Updated for Perl v5.40 to support the `:reader` field attribute and `__CLASS__` keyword * Use `Object::Pad` v0.806 on older perls, in order to support field initialiser expressions that can see earlier fields 0.06 2023-07-03 [CHANGES] * Updated documentation for Perl v5.38 release which now includes feature 'class' * Avoid Test::Fatal so the tests are core-only on Perl v5.38 0.05 2023-01-12 [CHANGES] * Don't enable the implied pragmata (strict, warnings, etc..) when using Object::Pad, because core version won't do that 0.04 2022-12-14 [CHANGES] * Support field initialiser expressions, the `:param` field attribute, and the `=`, `//=` and `||=` defaulting assignment modes * Don't unit-test anything to do with ADJUST receiving a hashref of parameters as soon it won't any more 0.03 2022-10-29 [CHANGES] * Forbid `ADJUST :params` from Object::Pad v0.70 0.02 2022-10-25 [CHANGES] * Support the `:isa` class attribute, now that perl's `feature-class` branch does 0.01 2022-08-27 First version, released on an unsuspecting world. Feature-Compat-Class-0.07/LICENSE000444001750001750 4653414642762622 15251 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 Feature-Compat-Class-0.07/MANIFEST000444001750001750 55114642762622 15322 0ustar00leoleo000000000000.editorconfig Build.PL Changes lib/Feature/Compat/Class.pm LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/01method.t t/02fields.t t/03create.t t/05subclass.t t/11method-signatures.t t/12fields-capture.t t/22fields-accesssors.t t/24fields-constructor.t t/31pad-outside.t t/50croak-method.t t/51pragmata.t t/52croak-scope.t t/99pod.t Feature-Compat-Class-0.07/META.json000444001750001750 207114642762622 15631 0ustar00leoleo000000000000{ "abstract" : "make C syntax available", "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" : "Feature-Compat-Class", "prereqs" : { "configure" : { "requires" : { "Module::Build" : "0.4004" } }, "runtime" : { "requires" : { "Object::Pad" : "0.806", "perl" : "5.014" } }, "test" : { "requires" : { "Test::More" : "0.88" } } }, "provides" : { "Feature::Compat::Class" : { "file" : "lib/Feature/Compat/Class.pm", "version" : "0.07" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.07", "x_serialization_backend" : "JSON::PP version 4.16" } Feature-Compat-Class-0.07/META.yml000444001750001750 125414642762622 15463 0ustar00leoleo000000000000--- abstract: 'make C syntax available' author: - 'Paul Evans ' build_requires: Test::More: '0.88' configure_requires: Module::Build: '0.4004' 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: Feature-Compat-Class provides: Feature::Compat::Class: file: lib/Feature/Compat/Class.pm version: '0.07' requires: Object::Pad: '0.806' perl: '5.014' resources: license: http://dev.perl.org/licenses/ version: '0.07' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Feature-Compat-Class-0.07/README000444001750001750 2146014642762622 15113 0ustar00leoleo000000000000NAME Feature::Compat::Class - make class syntax available SYNOPSIS use Feature::Compat::Class; class Point { field $x :param :reader = 0; field $y :param :reader = 0; method move_to ($new_x, $new_y) { $x = $new_x; $y = $new_y; } method describe { say "A point at ($x, $y)"; } } Point->new(x => 5, y => 10)->describe; DESCRIPTION This module provides the new class keyword and related others (method, field and ADJUST) in a forward-compatible way. Perl added such syntax at version 5.38.0, which is enabled by use feature 'class'; This syntax was further expanded in 5.40, adding the __CLASS__ keyword and :reader attribute on fields. On that version of perl or later, this module simply enables the core feature equivalent of using it directly. On such perls, this module will install with no non-core dependencies, and requires no C compiler. On older versions of perl before such syntax is availble in core, it is currently provided instead using the Object::Pad module, imported with a special set of options to configure it to only recognise the same syntax as the core perl feature, thus ensuring any code using it will still continue to function on that newer perl. This module is a work-in-progress, because the underlying feature 'class' is too. Many of the limitations and inabilities listed below are a result of the early-access nature of this branch, and are expected to be lifted as work progresses towards a more featureful and complete implementation. KEYWORDS The keywords provided by this module offer a subset of the abilities of those provided by Object::Pad, restricted to specifically only what is commonly supported by the core syntax as well. In general, the reader should first consult the documentation for the corresponding Object::Pad keyword, but the following notes may be of interest: class class NAME { ... } class NAME VERSION { ... } class NAME; ... class NAME VERSION; ... See also "class" in Object::Pad. There is no ability to declare any roles with :does. The legacy subkeywords for these are equally not supported. The :repr attribute is also not supported; the default representation type will always be selected. The :strict(params) attribute is not available, but all constructed classes will behave as if the attribute had been declared. Every generated constructor will check its parameters for key names left unhandled by ADJUST blocks, and throw an exception if any remain. The following class attributes are supported: :isa :isa(CLASS) :isa(CLASS CLASSVER) Since version 0.02. Declares a superclass that this class extends. At most one superclass is supported. If the package providing the superclass does not exist, an attempt is made to load it by code equivalent to require CLASS (); and thus it must either already exist, or be locatable via the usual @INC mechanisms. An optional version check can also be supplied; it performs the equivalent of BaseClass->VERSION( $ver ) Note that class blocks do not implicitly enable the strict and warnings pragmata; either when using the core feature or Object::Pad. This is to avoid surprises when eventually switching to purely using the core perl feature, which will not do that. Remember however that a use VERSION of a version v5.36 or above will enable both these pragmata anyway, so that will be sufficient. method method NAME { ... } method NAME; See also "method" in Object::Pad. Attributes are not supported, other than the usual ones provided by perl itself. Of these, only :lvalue is particularly useful. Lexical methods are not supported. field field $NAME; field @NAME; field %NAME; field $NAME = EXPR; field $NAME :ATTRS... = EXPR; See also "field" in Object::Pad. Most field attributes are not supported. In particular, rather than using the accessor-generator attributes you will have to create accessor methods yourself; such as field $var; method var { return $var; } method set_var ($new_var) { $var = $new_var; } Since version 0.04 fields of any type may take initialising expressions. Initialiser blocks are not supported. field $five = 5; Since version 0.07 field initialiser expressions can see earlier fields that have already been declared, and use their values: field $fullname :param; field $shortname :param = ( split m/ +/, $fullname )[0]; The following field attributes are supported: :param field $var :param; field $var :param(name) Since version 0.04. Declares that the constructor will take a named parameter to set the value for this field in a new instance. field $var :param = EXPR; Without a defaulting expression, the parameter is mandatory. When combined with a defaulting expression, the parameter is optional and the default will only apply if the named parameter was not passed to the constructor. field $var :param //= EXPR; field $var :param ||= EXPR; With both the :param attribute and a defaulting expression, the operator can also be written as //= or ||=. In this case, the defaulting expression will be used even if the caller passed an undefined value (for //=) or a false value (for ||=). This simplifies many situations where undef would not be a valid value for a field parameter. class C { field $timeout :param //= 20; } C->new( timeout => $args{timeout} ); # default applies if %args has no 'timeout' key, or if its value is undef :reader, :reader(NAME) Since version 0.07. Generates a reader method to return the current value of the field. If no name is given, the name of the field is used. A single prefix character _ will be removed if present. field $x :reader; # equivalent to field $x; method x { return $x } These are permitted on an field type, not just scalars. The reader method behaves identically to how a lexical variable would behave in the same context; namely returning a list of values from an array or key/value pairs from a hash when in list context, or the number of items or keys when in scalar context. field @items :reader; foreach my $item ( $obj->items ) { ... } # iterates the list of items my $count = $obj->items; # yields count of items ADJUST ADJUST { ... } See also "ADJUST" in Object::Pad. Attributes are not supported; in particular the :params attribute of Object::Pad v0.70. __CLASS__ my $classname = __CLASS__; Since version 0.07. Only valid within the body (or signature) of a method, an ADJUST block, or the initialising expression of a field. Yields the class name of the instance that the method, block or expression is invoked on. This is similar to the core perl __PACKAGE__ constant, except that it cares about the dynamic class of the actual instance, not the static class the code belongs to. When invoked by a subclass instance that inherited code from its superclass it yields the name of the class of the instance regardless of which class defined the code. For example, class BaseClass { ADJUST { say "Constructing an instance of " . __CLASS__; } } class DerivedClass :isa(BaseClass) { } my $obj = DerivedClass->new; Will produce the following output Constructing an instance of DerivedClass This is particularly useful in field initialisers for invoking (constant) methods on the invoking class to provide default values for fields. This way a subclass could provide a different value. class Timer { use constant DEFAULT_DURATION => 60; field $duration = __CLASS__->DEFAULT_DURATION; } class ThreeMinuteTimer :isa(Timer) { use constant DEFAULT_DURATION => 3 * 60; } Other Keywords The following other keywords provided by Object::Pad are not supported here at all: role BUILD, ADJUSTPARAMS has requires COMPATIBILITY NOTES This module may use either Object::Pad or the perl core class feature to implement its syntax. While the two behave very similarly and both conform to the description given above, the following differences should be noted. No known issues at this time AUTHOR Paul Evans Feature-Compat-Class-0.07/lib000755001750001750 014642762622 14621 5ustar00leoleo000000000000Feature-Compat-Class-0.07/lib/Feature000755001750001750 014642762622 16214 5ustar00leoleo000000000000Feature-Compat-Class-0.07/lib/Feature/Compat000755001750001750 014642762622 17437 5ustar00leoleo000000000000Feature-Compat-Class-0.07/lib/Feature/Compat/Class.pm000444001750001750 2222114642762622 21216 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, 2022-2024 -- leonerd@leonerd.org.uk package Feature::Compat::Class 0.07; use v5.14; use warnings; use feature (); use constant HAVE_FEATURE_CLASS => $^V ge v5.40; =head1 NAME C - make C syntax available =head1 SYNOPSIS use Feature::Compat::Class; class Point { field $x :param :reader = 0; field $y :param :reader = 0; method move_to ($new_x, $new_y) { $x = $new_x; $y = $new_y; } method describe { say "A point at ($x, $y)"; } } Point->new(x => 5, y => 10)->describe; =head1 DESCRIPTION This module provides the new C keyword and related others (C, C and C) in a forward-compatible way. Perl added such syntax at version 5.38.0, which is enabled by use feature 'class'; This syntax was further expanded in 5.40, adding the C<__CLASS__> keyword and C<:reader> attribute on fields. On that version of perl or later, this module simply enables the core feature equivalent of using it directly. On such perls, this module will install with no non-core dependencies, and requires no C compiler. On older versions of perl before such syntax is availble in core, it is currently provided instead using the L module, imported with a special set of options to configure it to only recognise the same syntax as the core perl feature, thus ensuring any code using it will still continue to function on that newer perl. This module is a work-in-progress, because the underlying C is too. Many of the limitations and inabilities listed below are a result of the early-access nature of this branch, and are expected to be lifted as work progresses towards a more featureful and complete implementation. =cut sub import { if( HAVE_FEATURE_CLASS ) { feature->import(qw( class )); require warnings; warnings->unimport(qw( experimental::class )); } else { require Object::Pad; Object::Pad->VERSION( '0.806' ); Object::Pad->import(qw( class method field ADJUST ), ':experimental(init_expr)', ':config(' . 'always_strict only_class_attrs=isa only_field_attrs=param,reader ' . 'no_field_block no_adjust_attrs no_implicit_pragmata' . ')', ); } } =head1 KEYWORDS The keywords provided by this module offer a subset of the abilities of those provided by C, restricted to specifically only what is commonly supported by the core syntax as well. In general, the reader should first consult the documentation for the corresponding C keyword, but the following notes may be of interest: =head2 class class NAME { ... } class NAME VERSION { ... } class NAME; ... class NAME VERSION; ... See also L. There is no ability to declare any roles with C<:does>. The legacy subkeywords for these are equally not supported. The C<:repr> attribute is also not supported; the default representation type will always be selected. The C<:strict(params)> attribute is not available, but all constructed classes will behave as if the attribute had been declared. Every generated constructor will check its parameters for key names left unhandled by C blocks, and throw an exception if any remain. The following class attributes are supported: =head3 :isa :isa(CLASS) :isa(CLASS CLASSVER) I Declares a superclass that this class extends. At most one superclass is supported. If the package providing the superclass does not exist, an attempt is made to load it by code equivalent to require CLASS (); and thus it must either already exist, or be locatable via the usual C<@INC> mechanisms. An optional version check can also be supplied; it performs the equivalent of BaseClass->VERSION( $ver ) Note that C blocks B implicitly enable the C and C pragmata; either when using the core feature or C. This is to avoid surprises when eventually switching to purely using the core perl feature, which will not do that. Remember however that a C of a version C or above will enable both these pragmata anyway, so that will be sufficient. =head2 method method NAME { ... } method NAME; See also L. Attributes are not supported, other than the usual ones provided by perl itself. Of these, only C<:lvalue> is particularly useful. Lexical methods are not supported. =head2 field field $NAME; field @NAME; field %NAME; field $NAME = EXPR; field $NAME :ATTRS... = EXPR; See also L. Most field attributes are not supported. In particular, rather than using the accessor-generator attributes you will have to create accessor methods yourself; such as field $var; method var { return $var; } method set_var ($new_var) { $var = $new_var; } I fields of any type may take initialising expressions. Initialiser blocks are not supported. field $five = 5; I field initialiser expressions can see earlier fields that have already been declared, and use their values: field $fullname :param; field $shortname :param = ( split m/ +/, $fullname )[0]; The following field attributes are supported: =head3 :param field $var :param; field $var :param(name) I Declares that the constructor will take a named parameter to set the value for this field in a new instance. field $var :param = EXPR; Without a defaulting expression, the parameter is mandatory. When combined with a defaulting expression, the parameter is optional and the default will only apply if the named parameter was not passed to the constructor. field $var :param //= EXPR; field $var :param ||= EXPR; With both the C<:param> attribute and a defaulting expression, the operator can also be written as C or C<||=>. In this case, the defaulting expression will be used even if the caller passed an undefined value (for C) or a false value (for C<||=>). This simplifies many situations where C would not be a valid value for a field parameter. class C { field $timeout :param //= 20; } C->new( timeout => $args{timeout} ); # default applies if %args has no 'timeout' key, or if its value is undef =head3 :reader, :reader(NAME) I Generates a reader method to return the current value of the field. If no name is given, the name of the field is used. A single prefix character C<_> will be removed if present. field $x :reader; # equivalent to field $x; method x { return $x } These are permitted on an field type, not just scalars. The reader method behaves identically to how a lexical variable would behave in the same context; namely returning a list of values from an array or key/value pairs from a hash when in list context, or the number of items or keys when in scalar context. field @items :reader; foreach my $item ( $obj->items ) { ... } # iterates the list of items my $count = $obj->items; # yields count of items =head2 ADJUST ADJUST { ... } See also L. Attributes are not supported; in particular the C<:params> attribute of C v0.70. =head2 __CLASS__ my $classname = __CLASS__; I Only valid within the body (or signature) of a C, an C block, or the initialising expression of a C. Yields the class name of the instance that the method, block or expression is invoked on. This is similar to the core perl C<__PACKAGE__> constant, except that it cares about the dynamic class of the actual instance, not the static class the code belongs to. When invoked by a subclass instance that inherited code from its superclass it yields the name of the class of the instance regardless of which class defined the code. For example, class BaseClass { ADJUST { say "Constructing an instance of " . __CLASS__; } } class DerivedClass :isa(BaseClass) { } my $obj = DerivedClass->new; Will produce the following output Constructing an instance of DerivedClass This is particularly useful in field initialisers for invoking (constant) methods on the invoking class to provide default values for fields. This way a subclass could provide a different value. class Timer { use constant DEFAULT_DURATION => 60; field $duration = __CLASS__->DEFAULT_DURATION; } class ThreeMinuteTimer :isa(Timer) { use constant DEFAULT_DURATION => 3 * 60; } =head2 Other Keywords The following other keywords provided by C are not supported here at all: role BUILD, ADJUSTPARAMS has requires =cut =head1 COMPATIBILITY NOTES This module may use either L or the perl core C feature to implement its syntax. While the two behave very similarly and both conform to the description given above, the following differences should be noted. =over 4 =item I =back =cut =head1 AUTHOR Paul Evans =cut 0x55AA; Feature-Compat-Class-0.07/t000755001750001750 014642762622 14316 5ustar00leoleo000000000000Feature-Compat-Class-0.07/t/00use.t000444001750001750 15714642762622 15557 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use_ok( "Feature::Compat::Class" ); done_testing; Feature-Compat-Class-0.07/t/01method.t000444001750001750 227014642762622 16262 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; # We can't just clone many of the tests from Object-Pad/t/01method.t because a # lot of those use `BUILD` blocks # # We'll mostly copy core perl's t/class/class.t and t/class/method.t instead { class Test1 { method hello { return "Hello, world!" } method classname { return __CLASS__; } } my $obj = Test1->new; isa_ok( $obj, "Test1", '$obj' ); is( $obj->hello, "Hello, world!", '$obj->hello' ); is( $obj->classname, "Test1", '$obj->classname yields __CLASS__' ); } # $self in method { class Test2 { method retself { return $self } } my $obj = Test2->new; is( $obj->retself, $obj, '$self inside method' ); } # $self is shifted from @_ { class Test3 { method args { return @_ } } my $obj = Test3->new; is_deeply( [ $obj->args( "a", "b" ) ], [ "a", "b" ], '$self is shifted from @_' ); } # anonymous methods { class Test4 { method genanon { return method { "Result" }; } } my $obj = Test4->new; my $mref = $obj->genanon; is( $obj->$mref, "Result", 'anonymous method can be invoked' ); } done_testing; Feature-Compat-Class-0.07/t/02fields.t000444001750001750 453614642762622 16260 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; # We can't just clone many of the tests from Object-Pad/t/02field.t because a # lot of those use init_expr class Counter { field $count = 0; method inc { $count++ } method describe { "Count is now $count" } } { my $counter = Counter->new; $counter->inc; $counter->inc; $counter->inc; is( $counter->describe, "Count is now 3", '$counter->describe after $counter->inc x 3' ); my $counter2 = Counter->new; is( $counter2->describe, "Count is now 0", '$counter2 has its own $count' ); } # Basic init expressions { class AllTheTypes { field $scalar = 123; field @array = ( 45, 67 ); field %hash = ( 89 => 10 ); method test { Test::More::is( $scalar, 123, '$scalar field' ); Test::More::is_deeply( \@array, [ 45, 67 ], '@array field' ); Test::More::is_deeply( \%hash, { 89 => 10 }, '%hash field' ); } } AllTheTypes->new->test; } # Fields are visible to string-eval() { class Evil { field $field; method test { $field = "the value"; ::is( eval '$field', "the value", 'fields are visible to string eval()' ); } } Evil->new->test; } # fields can be captured by anon subs { class ClosureCounter { field $count; method make_incrsub { return sub { $count++ }; } method count { $count } } my $counter = ClosureCounter->new; my $inc = $counter->make_incrsub; $inc->(); $inc->(); is( $counter->count, 2, '->count after invoking incrsub x 2' ); } # fields can be captured by anon methods { class MClosureCounter { field $count; method make_incrmeth { return method { $count++ }; } method count { $count } } my $counter = MClosureCounter->new; my $inc = $counter->make_incrmeth; $counter->$inc(); $counter->$inc(); is( $counter->count, 2, '->count after invoking incrmeth x 2' ); } # fields are visible during initialiser expressions of later fields { class FieldFromField { field $one = 1; field $two = $one + 1; field $three = $two + 1; method three { return $three; } } is( FieldFromField->new->three, 3, 'Scalar fields can be initialised from earlier fields' ); } done_testing; Feature-Compat-Class-0.07/t/03create.t000444001750001750 77014642762622 16232 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; { my @called; my $class_in_ADJUST; class Test1 { ADJUST { push @called, "ADJUST-1"; } ADJUST { push @called, "ADJUST-2"; $class_in_ADJUST = __CLASS__; } } Test1->new(); is_deeply( \@called, [qw( ADJUST-1 ADJUST-2 )], 'ADJUST blocks invoked in sequence' ); is( $class_in_ADJUST, "Test1", '__CLASS__ during ADJUST block' ); } done_testing; Feature-Compat-Class-0.07/t/05subclass.t000444001750001750 72314642762622 16606 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; { class Test1Base { method describe { "Value is " . $self->m; } } class Test1Derived :isa(Test1Base) { method m { 123 } } my $obj = Test1Derived->new; isa_ok( $obj, "Test1Derived", '$obj' ); isa_ok( $obj, "Test1Base", '$obj' ); is( $obj->describe, "Value is 123", 'Object can invoke superclass methods' ); } done_testing; Feature-Compat-Class-0.07/t/11method-signatures.t000444001750001750 135214642762622 20445 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; BEGIN { $] >= 5.026000 or plan skip_all => "No parse_subsignature()"; } use Feature::Compat::Class; class List { field @values; method push ( @more ) { push @values, @more } method nshift ( $n ) { splice @values, 0, $n } } { my $l = List->new; $l->push(qw( a b c d )); is_deeply( [ $l->nshift( 2 ) ], [qw( a b )], '$l->nshift yields values' ); } class Test2 { field $name; ADJUST { $name = "Unit test" } method greet ( $message = "Hello, $name" ) { return $message; } } { my $obj = Test2->new; is( $obj->greet, "Hello, Unit test", 'subroutine signature default exprs can see instance fields' ); } done_testing; Feature-Compat-Class-0.07/t/12fields-capture.t000444001750001750 62514642762622 17675 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; class Test1 { field $count; method inc { $count++ }; method make_incrsub { return sub { $count++ }; } method count { $count } } { my $obj = Test1->new; my $inc = $obj->make_incrsub; $inc->(); $inc->(); is( $obj->count, 2, '->count after invoking incrsub' ); } done_testing; Feature-Compat-Class-0.07/t/22fields-accesssors.t000444001750001750 263614642762622 20427 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; my $MATCH_ARGCOUNT = # Perl since 5.33.6 adds got-vs-expected counts to croak message $] >= 5.033006 ? qr/ \(got \d+; expected \d+\)/ : ""; # readers { class AllTheTypesReader { field $sv :reader = 123; field @av :reader = qw( one two three ); field %hv :reader = (one => 1, two => 2); } my $allthetypes = AllTheTypesReader->new; is( $allthetypes->sv, 123, ':reader on scalar field' ); is_deeply( [ $allthetypes->av ], [qw( one two three )], ':reader on array field' ); is_deeply( { $allthetypes->hv }, { one => 1, two => 2 }, ':reader on hash field' ); is( scalar $allthetypes->av, 3, ':reader on array field in scalar context' ); # On perl 5.26 onwards this yields the number of keys; before that it # stringifies to something like "2/8" but that's not terribly reliable, so # don't bother testing that is( scalar $allthetypes->hv, 2, ':reader on hash field in scalar context' ) if $] >= 5.028; # Reader complains if given any arguments my $LINE = __LINE__+1; ok( !defined eval { AllTheTypesReader->new->sv(55); 1 }, 'reader method complains if given any arguments' ); like( $@, qr/^Too many arguments for subroutine 'AllTheTypesReader::sv'$MATCH_ARGCOUNT(?: at \S+ line $LINE\.)?$/, 'exception message from too many arguments to reader' ); } done_testing; Feature-Compat-Class-0.07/t/24fields-constructor.t000444001750001750 471214642762622 20643 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; class Point { field $x :param; field $y :param = 0; method pos { return ( $x, $y ); } } { my $point = Point->new( x => 10 ); is_deeply( [ $point->pos ], [ 10, 0 ], 'Point with default y' ); } # Object::Pad vs. core perl have slightly different quoting behaviours in # exception messages. my $QUOT = qr/["]?/; # Required params checking { my $LINE = __LINE__+1; ok( !defined eval { Point->new(); 1 }, 'constructor complains about missing required params' ); like( $@, qr/^Required parameter 'x' is missing for ${QUOT}Point${QUOT} constructor at \S+ line $LINE\./, 'exception message from missing parameter' ); } # Strict params checking { class Colour { field $red :param = 0; field $green :param = 0; field $blue :param = 0; } my $LINE = __LINE__+1; ok( !defined eval { Colour->new( yellow => 1 ); 1 }, 'constructor complains about unrecognised param name' ); like( $@, qr/^Unrecognised parameters for ${QUOT}Colour${QUOT} constructor: '?yellow'? at \S+ line $LINE\./, 'exception message from unrecognised parameter' ); } # Param assignment modes { class AllTheOps { field $exists :param = "default"; field $defined :param //= "default"; field $true :param ||= "default"; method values { return ( $exists, $defined, $true ); } } is_deeply( [ AllTheOps->new(exists => "value", defined => "value", true => "value")->values ], [ "value", "value", "value" ], 'AllTheOps for true values' ); is_deeply( [ AllTheOps->new(exists => 0, defined => 0, true => 0)->values ], [ 0, 0, "default" ], 'AllTheOps for false values' ); is_deeply( [ AllTheOps->new(exists => undef, defined => undef, true => undef)->values ], [ undef, "default", "default" ], 'AllTheOps for undef values' ); is_deeply( [ AllTheOps->new()->values ], [ "default", "default", "default" ], 'AllTheOps for missing values' ); } # field initialiser expressions permit a __CLASS__ { class ClassInInitialiser { field $classname :reader = __CLASS__; } is( ClassInInitialiser->new->classname, "ClassInInitialiser", '__CLASS__ in field initialisers' ); class SubclassNamedHere :isa( ClassInInitialiser ) { } is( SubclassNamedHere->new->classname, "SubclassNamedHere", '__CLASS__ sees subclass name correctly' ); } done_testing; Feature-Compat-Class-0.07/t/31pad-outside.t000444001750001750 155514642762622 17230 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; { class Test1 { field $count; my $allcount = 0; method inc { $count++; $allcount++ } method count { $count } sub allcount { $allcount } } my $objA = Test1->new; my $objB = Test1->new; $objA->inc; $objB->inc; is( $objA->count, 1, '$objA->count' ); is( Test1->allcount, 2, 'Test1->allcount' ); } # anon methods can capture lexicals (RT132178) { class Test2 { foreach my $letter (qw( x y z )) { my $code = method { return uc $letter; }; no strict 'refs'; *$letter = $code; } } my $obj = Test2->new; is( $obj->x, "X", 'generated anon method' ); is( $obj->y, "Y", 'generated anon method' ); is( $obj->z, "Z", 'generated anon method' ); } done_testing; Feature-Compat-Class-0.07/t/50croak-method.t000444001750001750 106214642762622 17361 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; # This test checks that various error conditions result in exceptions being # thrown. While the core implementation is still being developed we won't # assert on the exact message text. class Test1 { field $x; method clear { $x = 0 } } { ok( !defined eval { Test1->clear }, 'method on non-instance fails' ); } { my $obj = bless [], "DifferentClass"; ok( !defined eval { $obj->Test1::clear }, 'method on wrong class fails' ); } done_testing; Feature-Compat-Class-0.07/t/51pragmata.t000444001750001750 50314642762622 16560 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; { no strict; ok( defined eval <<'EOPERL', class TestStrict { sub x { $def = $def; } } "ok" EOPERL 'class scope does not imply use strict' ) or diag( "Failure was: $@" ); } done_testing; Feature-Compat-Class-0.07/t/52croak-scope.t000444001750001750 114014642762622 17211 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; use Feature::Compat::Class; # This test checks that various error conditions result in exceptions being # thrown. While the core implementation is still being developed we won't # assert on the exact message text. { ok( !eval <<'EOPERL', field $field; EOPERL 'field outside class fails' ); } { ok( !eval <<'EOPERL', class AClass { } field $field; EOPERL 'field after closed class block fails' ); } { ok( !eval <<'EOPERL', method m() { } EOPERL 'method outside class fails' ); } done_testing; Feature-Compat-Class-0.07/t/99pod.t000444001750001750 25614642762622 15567 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok();