Struct-Dumb-0.14000755001750001750 014371710300 12324 5ustar00leoleo000000000000Struct-Dumb-0.14/Build.PL000444001750001750 54014371710300 13734 0ustar00leoleo000000000000use strict; use warnings; use Module::Build; my $build = Module::Build->new( module_name => 'Struct::Dumb', test_requires => { 'Test2::V0' => 0, }, configure_requires => { 'Module::Build' => '0.4004', # test_requires }, license => 'perl', create_license => 1, create_readme => 1, ); $build->create_build_script; Struct-Dumb-0.14/Changes000444001750001750 427514371710300 13764 0ustar00leoleo000000000000Revision history for Struct-Dumb 0.14 2023-02-11 [CHANGES] * Updates to `feature 'class'` support, using `:param` instead of `ADJUST` blocks * Swap all unit tests from `Test::More` to `Test2::V0` * Drop test-time dependence on `Test::Fatal` 0.13 2022-08-27 [CHANGES] * Use `feature 'class'` instead of blessed ARRAYrefs on perls which support that, as an experiment to test how well that works 0.12 2020-04-21 [BUGFIXES] * Better ways to detect late-loading of Data::Dump. + Avoid touching its $VERSION + Check it is loaded when the destroywatch is invoked before actually applying filter 0.11 2020-04-17 [BUGFIXES] * Fix for detecting Data::Dump being loaded afterward Struct::Dumb 0.10 2020-04-17 [CHANGES] * Optional named parameter versions of constructor functions * Apply hackery to Data::Dump to allow it to print structures 0.09 2016/03/09 17:49:17 [CHANGES] * Allow callers to allow ARRAY dereference for special circumstances 0.08 2015/12/15 17:45:46 [CHANGES] * Support perl 5.8.x (which lacks overloading.pm) 0.07 2015/10/11 12:37:51 [BUGFIXES] * Provide the other conversion overload operations and allow fallback 0.06 2015/10/07 00:24:52 [BUGFIXES] * Ensure that structs are still boolean true 0.05 2015/10/06 23:12:58 [BUGFIXES] * Throw an exception on attempts to dereference a struct as an array (RT107583) * Throw an exception if accessor-mutators are invoked with extra arguments * Give AUTOLOAD :lvalue context so it reports the right message for attempts to assign to missing fields (RT107577) 0.04 2015/09/30 18:29:01 [CHANGES] * Support creating a predicate test function 0.03 2014/07/25 10:01:02 [CHANGES] * Support named constructors (RT97452) 0.02 BUGFIXES: * Fix unit tests to cope with new Carp message format, with the "." appended 0.01 First version, released on an unsuspecting world. Struct-Dumb-0.14/LICENSE000444001750001750 4375514371710300 13524 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 Struct-Dumb-0.14/MANIFEST000444001750001750 34014371710300 13567 0ustar00leoleo000000000000Build.PL Changes lib/Struct/Dumb.pm LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/01point.t t/02scope.t t/03readonly.t t/04named.t t/05predicate.t t/10data-dump.t t/11data-dump-late.t t/99pod.t Struct-Dumb-0.14/META.json000444001750001750 164714371710300 14112 0ustar00leoleo000000000000{ "abstract" : "make simple lightweight record-like structures", "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" : "Struct-Dumb", "prereqs" : { "configure" : { "requires" : { "Module::Build" : "0.4004" } }, "test" : { "requires" : { "Test2::V0" : "0" } } }, "provides" : { "Struct::Dumb" : { "file" : "lib/Struct/Dumb.pm", "version" : "0.14" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.14", "x_serialization_backend" : "JSON::PP version 4.07" } Struct-Dumb-0.14/META.yml000444001750001750 115314371710300 13732 0ustar00leoleo000000000000--- abstract: 'make simple lightweight record-like structures' author: - 'Paul Evans ' build_requires: Test2::V0: '0' configure_requires: Module::Build: '0.4004' 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: Struct-Dumb provides: Struct::Dumb: file: lib/Struct/Dumb.pm version: '0.14' resources: license: http://dev.perl.org/licenses/ version: '0.14' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Struct-Dumb-0.14/README000444001750001750 1540314371710300 13364 0ustar00leoleo000000000000NAME Struct::Dumb - make simple lightweight record-like structures SYNOPSIS use Struct::Dumb; struct Point => [qw( x y )]; my $point = Point(10, 20); printf "Point is at (%d, %d)\n", $point->x, $point->y; $point->y = 30; printf "Point is now at (%d, %d)\n", $point->x, $point->y; struct Point3D => [qw( x y z )], named_constructor => 1; my $point3d = Point3D( z => 12, x => 100, y => 50 ); printf "Point3d's height is %d\n", $point3d->z; struct Point3D => [qw( x y z )], predicate => "is_Point3D"; my $point3d = Point3D( 1, 2, 3 ); printf "This is a Point3D\n" if is_Point3D( $point3d ); use Struct::Dumb qw( -named_constructors ) struct Point3D => [qw( x y z )]; my $point3d = Point3D( x => 100, z => 12, y => 50 ); DESCRIPTION Struct::Dumb creates record-like structure types, similar to the struct keyword in C, C++ or C#, or Record in Pascal. An invocation of this module will create a construction function which returns new object references with the given field values. These references all respond to lvalue methods that access or modify the values stored. It's specifically and intentionally not meant to be an object class. You cannot subclass it. You cannot provide additional methods. You cannot apply roles or mixins or metaclasses or traits or antlers or whatever else is in fashion this week. On the other hand, it is tiny, creates cheap lightweight array-backed structures, uses nothing outside of core. It's intended simply to be a slightly nicer way to store data structures, where otherwise you might be tempted to abuse a hash, complete with the risk of typoing key names. The constructor will croak if passed the wrong number of arguments, as will attempts to refer to fields that don't exist. Accessor-mutators will croak if invoked with arguments. (This helps detect likely bugs such as accidentally passing in the new value as an argument, or attempting to invoke a stored CODE reference by passing argument values directly to the accessor.) $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(30)' usage: main::Point($x, $y) at -e line 1 $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(10,20)->z' main::Point does not have a 'z' field at -e line 1 $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(1,2)->x(3)' main::Point->x invoked with arguments at -e line 1. Objects in this class are (currently) backed by an ARRAY reference store, though this is an internal implementation detail and should not be relied on by using code. Attempting to dereference the object as an ARRAY will throw an exception. Note: That on development perls that support use feature 'class', this is used instead of a blessed ARRAY reference. This implementation choice should be transparent to the end-user, as all the same features are supported. CONSTRUCTOR FORMS The struct and readonly_struct declarations create two different kinds of constructor function, depending on the setting of the named_constructor option. When false, the constructor takes positional values in the same order as the fields were declared. When true, the constructor takes a key/value pair list in no particular order, giving the value of each named field. This option can be specified to the struct and readonly_struct functions. It defaults to false, but it can be set on a per-package basis to default true by supplying the -named_constructors option on the use statement. When using named constructors, individual fields may be declared as being optional. By preceeding the field name with a ? character, the constructor is instructed not to complain if a named parameter is not given for that field; instead it will be set to undef. struct Person => [qw( name age ?address )], named_constructor => 1; my $bob = Person( name => "Bob", age => 20 ); # This is valid because 'address' is marked as optional FUNCTIONS struct struct $name => [ @fieldnames ], named_constructor => (1|0), predicate => "is_$name"; Creates a new structure type. This exports a new function of the type's name into the caller's namespace. Invoking this function returns a new instance of a type that implements those field names, as accessors and mutators for the fields. Takes the following options: named_constructor => BOOL Determines whether the structure will take positional or named arguments. predicate => STR If defined, gives the name of a second function to export to the caller's namespace. This function will be a type test predicate; that is, a function that takes a single argmuent, and returns true if-and-only-if that argument is an instance of this structure type. readonly_struct readonly_struct $name => [ @fieldnames ], ... Similar to "struct", but instances of this type are immutable once constructed. The field accessor methods will not be marked with the :lvalue attribute. Takes the same options as "struct". DATA::DUMP FILTER Since version 0.10. If Data::Dump is loaded, an extra filter is applied so that struct instances are printed in a format matching that which would construct them. struct Colour => [qw( red green blue )]; use Data::Dump; my %hash = ( col => Colour( 0.8, 0.5, 0.2 ) ); Data::Dump::dd \%hash; # prints {col => main::Colour(0.8, 0.5, 0.2)} NOTES Allowing ARRAY dereference The way that forbidding access to instances as if they were ARRAY references is currently implemented uses an internal method on the generated structure class called _forbid_arrayification. If special circumstances require that this exception mechanism be bypassed, the method can be overloaded with an empty sub {} body, allowing the struct instances in that class to be accessed like normal ARRAY references. For good practice this should be limited by a local override. For example, Devel::Cycle needs to access the instances as plain ARRAY references so it can walk the data structure looking for reference cycles. use Devel::Cycle; { no warnings 'redefine'; local *Point::_forbid_arrayification = sub {}; memory_cycle_ok( $point ); } TODO * Consider adding an coerce_hash option, giving name of another function to convert structs to key/value pairs, or a HASH ref. AUTHOR Paul Evans Struct-Dumb-0.14/lib000755001750001750 014371710300 13072 5ustar00leoleo000000000000Struct-Dumb-0.14/lib/Struct000755001750001750 014371710300 14356 5ustar00leoleo000000000000Struct-Dumb-0.14/lib/Struct/Dumb.pm000444001750001750 3220614371710300 15763 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, 2012-2022 -- leonerd@leonerd.org.uk package Struct::Dumb; use strict; use warnings; our $VERSION = '0.14'; use Carp; use Scalar::Util qw( refaddr ); # 'overloading.pm' was only added in 5.10 # Before that we can't easily implement forbidding of @{} overload, so lets not use constant HAVE_OVERLOADING => eval { require overloading }; use constant HAVE_FEATURE_CLASS => defined eval { require feature; $feature::feature{class} }; =head1 NAME C - make simple lightweight record-like structures =head1 SYNOPSIS use Struct::Dumb; struct Point => [qw( x y )]; my $point = Point(10, 20); printf "Point is at (%d, %d)\n", $point->x, $point->y; $point->y = 30; printf "Point is now at (%d, %d)\n", $point->x, $point->y; Z<> struct Point3D => [qw( x y z )], named_constructor => 1; my $point3d = Point3D( z => 12, x => 100, y => 50 ); printf "Point3d's height is %d\n", $point3d->z; Z<> struct Point3D => [qw( x y z )], predicate => "is_Point3D"; my $point3d = Point3D( 1, 2, 3 ); printf "This is a Point3D\n" if is_Point3D( $point3d ); Z<> use Struct::Dumb qw( -named_constructors ) struct Point3D => [qw( x y z )]; my $point3d = Point3D( x => 100, z => 12, y => 50 ); =head1 DESCRIPTION C creates record-like structure types, similar to the C keyword in C, C++ or C#, or C in Pascal. An invocation of this module will create a construction function which returns new object references with the given field values. These references all respond to lvalue methods that access or modify the values stored. It's specifically and intentionally not meant to be an object class. You cannot subclass it. You cannot provide additional methods. You cannot apply roles or mixins or metaclasses or traits or antlers or whatever else is in fashion this week. On the other hand, it is tiny, creates cheap lightweight array-backed structures, uses nothing outside of core. It's intended simply to be a slightly nicer way to store data structures, where otherwise you might be tempted to abuse a hash, complete with the risk of typoing key names. The constructor will C if passed the wrong number of arguments, as will attempts to refer to fields that don't exist. Accessor-mutators will C if invoked with arguments. (This helps detect likely bugs such as accidentally passing in the new value as an argument, or attempting to invoke a stored C reference by passing argument values directly to the accessor.) $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(30)' usage: main::Point($x, $y) at -e line 1 $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(10,20)->z' main::Point does not have a 'z' field at -e line 1 $ perl -E 'use Struct::Dumb; struct Point => [qw( x y )]; Point(1,2)->x(3)' main::Point->x invoked with arguments at -e line 1. Objects in this class are (currently) backed by an ARRAY reference store, though this is an internal implementation detail and should not be relied on by using code. Attempting to dereference the object as an ARRAY will throw an exception. I: That on development perls that support C, this is used instead of a blessed ARRAY reference. This implementation choice should be transparent to the end-user, as all the same features are supported. =head2 CONSTRUCTOR FORMS The C and C declarations create two different kinds of constructor function, depending on the setting of the C option. When false, the constructor takes positional values in the same order as the fields were declared. When true, the constructor takes a key/value pair list in no particular order, giving the value of each named field. This option can be specified to the C and C functions. It defaults to false, but it can be set on a per-package basis to default true by supplying the C<-named_constructors> option on the C statement. When using named constructors, individual fields may be declared as being optional. By preceeding the field name with a C character, the constructor is instructed not to complain if a named parameter is not given for that field; instead it will be set to C. struct Person => [qw( name age ?address )], named_constructor => 1; my $bob = Person( name => "Bob", age => 20 ); # This is valid because 'address' is marked as optional =cut sub import { my $pkg = shift; my $caller = caller; my %default_opts; my %syms; foreach ( @_ ) { if( $_ eq "-named_constructors" ) { $default_opts{named_constructor} = 1; } else { $syms{$_}++; } } keys %syms or $syms{struct}++; my %export; if( delete $syms{struct} ) { $export{struct} = sub { my ( $name, $fields, @opts ) = @_; _struct( $name, $fields, scalar caller, lvalue => 1, %default_opts, @opts ); }; } if( delete $syms{readonly_struct} ) { $export{readonly_struct} = sub { my ( $name, $fields, @opts ) = @_; _struct( $name, $fields, scalar caller, lvalue => 0, %default_opts, @opts ); }; } if( keys %syms ) { croak "Unrecognised export symbols " . join( ", ", keys %syms ); } no strict 'refs'; *{"${caller}::$_"} = $export{$_} for keys %export; } =head1 FUNCTIONS =cut my %_STRUCT_PACKAGES; sub _struct { my ( $name, $_fields, $caller, %opts ) = @_; my $lvalue = !!$opts{lvalue}; my $named = !!$opts{named_constructor}; my $pkg = "${caller}::$name"; my @fields = @$_fields; my %optional; s/^\?// and $optional{$_}++ for @fields; my %subs; $subs{DESTROY} = sub {}; $subs{AUTOLOAD} = sub :lvalue { my ( $field ) = our $AUTOLOAD =~ m/::([^:]+)$/; croak "$pkg does not have a '$field' field"; my $dummy; ## croak can't be last because it isn't lvalue, so this line is required }; my $constructor; if( HAVE_FEATURE_CLASS ) { _build_class_for_feature_class( $pkg, \@fields, \%optional, $named, $lvalue, \$constructor ); } else { _build_class_for_classical( $pkg, \@fields, \%optional, $named, $lvalue, \$constructor ); } no strict 'refs'; *{"${pkg}::$_"} = $subs{$_} for keys %subs; *{"${caller}::$name"} = $constructor; if( my $predicate = $opts{predicate} ) { *{"${caller}::$predicate"} = sub { ( ref($_[0]) || "" ) eq $pkg }; } *{"${pkg}::_forbid_arrayification"} = sub { return if !HAVE_OVERLOADING and caller eq __PACKAGE__; croak "Cannot use $pkg as an ARRAY reference" }; require overload; $pkg->overload::OVERLOAD( '@{}' => sub { $_[0]->_forbid_arrayification; return $_[0] }, '0+' => sub { refaddr $_[0] }, '""' => sub { sprintf "%s=Struct::Dumb(%#x)", $pkg, refaddr $_[0] }, 'bool' => sub { 1 }, fallback => 1, ); $_STRUCT_PACKAGES{$pkg} = { named => $named, fields => \@fields, } } sub _build_class_for_classical { my ( $pkg, $fields, $optional, $named, $lvalue, $constructorvar ) = @_; my @fields = @$fields; if( $named ) { $$constructorvar = sub { my %values = @_; my @values; foreach ( @fields ) { exists $values{$_} or $optional->{$_} or croak "usage: $pkg requires '$_'"; push @values, delete $values{$_}; } if( my ( $extrakey ) = keys %values ) { croak "usage: $pkg does not recognise '$extrakey'"; } bless \@values, $pkg; }; } else { my $fieldcount = @fields; my $argnames = join ", ", map "\$$_", @fields; $$constructorvar = sub { @_ == $fieldcount or croak "usage: $pkg($argnames)"; bless [ @_ ], $pkg; }; } my %subs; foreach ( 0 .. $#fields ) { my $idx = $_; my $field = $fields[$idx]; BEGIN { overloading->unimport if HAVE_OVERLOADING; } $subs{$field} = $lvalue ? sub :lvalue { @_ > 1 and croak "$pkg->$field invoked with arguments"; shift->[$idx] } : sub { @_ > 1 and croak "$pkg->$field invoked with arguments"; shift->[$idx] }; } no strict 'refs'; *{"${pkg}::$_"} = $subs{$_} for keys %subs; } sub _build_class_for_feature_class { my ( $pkg, $fields, $optional, $named, $lvalue, $constructorvar ) = @_; my @fields = @$fields; my %optional = %$optional; if( $named ) { my %fieldnames = map { $_ => 1 } @fields; $$constructorvar = sub { my %values = @_; foreach ( @fields ) { exists $values{$_} or $optional{$_} or croak "usage: $pkg requires '$_'"; } $fieldnames{$_} or croak "usage: $pkg does not recognise '$_'" for keys %values; return $pkg->new( %values ); }; } else { my $fieldcount = @fields; my $argnames = join ", ", map "\$$_", @fields; $$constructorvar = sub { @_ == $fieldcount or croak "usage: $pkg($argnames)"; my %values; @values{@fields} = @_; return $pkg->new( %values ); }; } $lvalue = $lvalue ? " :lvalue" : ""; my @fieldcode = map { my $name = $_; my $var = "\$$name"; " field $var :param = undef;", " method $name$lvalue { \@_ and croak \"$pkg->$name invoked with arguments\"; $var }", } @$fields; my $code = join( "\n", "use experimental 'class';", "class $pkg {", " use Carp;", @fieldcode, "}", "" ); eval "$code; 1" or die $@; } =head2 struct struct $name => [ @fieldnames ], named_constructor => (1|0), predicate => "is_$name"; Creates a new structure type. This exports a new function of the type's name into the caller's namespace. Invoking this function returns a new instance of a type that implements those field names, as accessors and mutators for the fields. Takes the following options: =over 4 =item named_constructor => BOOL Determines whether the structure will take positional or named arguments. =item predicate => STR If defined, gives the name of a second function to export to the caller's namespace. This function will be a type test predicate; that is, a function that takes a single argmuent, and returns true if-and-only-if that argument is an instance of this structure type. =back =cut =head2 readonly_struct readonly_struct $name => [ @fieldnames ], ... Similar to L, but instances of this type are immutable once constructed. The field accessor methods will not be marked with the C<:lvalue> attribute. Takes the same options as L. =cut =head1 DATA::DUMP FILTER I If L is loaded, an extra filter is applied so that struct instances are printed in a format matching that which would construct them. struct Colour => [qw( red green blue )]; use Data::Dump; my %hash = ( col => Colour( 0.8, 0.5, 0.2 ) ); Data::Dump::dd \%hash; # prints {col => main::Colour(0.8, 0.5, 0.2)} =head1 NOTES =head2 Allowing ARRAY dereference The way that forbidding access to instances as if they were ARRAY references is currently implemented uses an internal method on the generated structure class called C<_forbid_arrayification>. If special circumstances require that this exception mechanism be bypassed, the method can be overloaded with an empty C body, allowing the struct instances in that class to be accessed like normal ARRAY references. For good practice this should be limited by a C override. For example, L needs to access the instances as plain ARRAY references so it can walk the data structure looking for reference cycles. use Devel::Cycle; { no warnings 'redefine'; local *Point::_forbid_arrayification = sub {}; memory_cycle_ok( $point ); } =head1 TODO =over 4 =item * Consider adding an C option, giving name of another function to convert structs to key/value pairs, or a HASH ref. =back =head1 AUTHOR Paul Evans =cut sub maybe_apply_datadump_filter { return unless $INC{"Data/Dump.pm"}; require Data::Dump::Filtered; Data::Dump::Filtered::add_dump_filter( sub { my ( $ctx, $obj ) = @_; return undef unless my $meta = $_STRUCT_PACKAGES{ $ctx->class }; my $fields = $meta->{fields}; return { dump => sprintf "%s(%s)", $ctx->class, join ", ", map { my $field = $fields->[$_]; ( $meta->{named} ? "$field => " : "" ) . Data::Dump::dump($obj->$field) } 0 .. $#$fields }; }); } if( defined &Data::Dump::dump ) { maybe_apply_datadump_filter; } else { # A package var we observe that Data/Dump.pm seems to set when loaded # We can't attach to VERSION because too many other things get upset by # that. $Data::Dump::DEBUG = bless \( my $x = \&maybe_apply_datadump_filter ), "Struct::Dumb::_DestroyWatch"; } { package Struct::Dumb::_DestroyWatch; my $GD = 0; END { $GD = 1 } sub DESTROY { ${$_[0]}->() unless $GD; } } 0x55AA; Struct-Dumb-0.14/t000755001750001750 014371710300 12567 5ustar00leoleo000000000000Struct-Dumb-0.14/t/00use.t000444001750001750 17014371710300 14023 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; require Struct::Dumb; pass "Modules loaded"; done_testing; Struct-Dumb-0.14/t/01point.t000444001750001750 333614371710300 14410 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; use Scalar::Util qw( refaddr ); use Struct::Dumb; struct Point => [qw( x y )]; my $point = Point(10, 20); ok( ref $point, '$point is a ref' ); can_ok( $point, "x" ); is( $point->x, 10, '$point->x is 10' ); $point->y = 30; is( $point->y, 30, '$point->y is 30 after mutation' ); like( dies { $point->z }, qr/^main::Point does not have a 'z' field at \S+ line \d+\.?\n/, '$point->z throws exception' ); like( dies { $point->z = 40 }, qr/^main::Point does not have a 'z' field at \S+ line \d+\.?\n/, '$point->z :lvalue throws exception' ); like( dies { Point(30) }, qr/^usage: main::Point\(\$x, \$y\) at \S+ line \d+\.?\n/, 'Point(30) throws usage exception' ); like( dies { @{ Point(0, 0) } }, qr/^Cannot use main::Point as an ARRAY reference at \S+ line \d+\.?\n/, 'Array deref throws exception' ); SKIP: { skip "Instances are not ARRAYs", 1 unless Scalar::Util::reftype( Point(1, 1) ) eq "ARRAY"; ok( !( local $@ = dies { no warnings 'redefine'; local *Point::_forbid_arrayification = sub {}; @{ Point(2, 2) }; } ), 'Array deref succeeds with locally-overridden forbid function' ) or diag( "Exception was $@" ); } like( dies { $point->x(50) }, qr/^main::Point->x invoked with arguments at \S+ line \d+\.?\n/, 'Accessor with arguments throws exception' ); ok( !( local $@ = dies { !! Point(0, 0) } ), 'Point is boolean true' ) or diag( "Exception was $@" ); is( $point + 0, refaddr $point, 'Point numifies to its reference address' ); like( "$point", qr/^main::Point=Struct::Dumb\(0x[0-9a-fA-F]+\)$/, 'Point stringifies to something sensible' ); done_testing; Struct-Dumb-0.14/t/02scope.t000444001750001750 54714371710300 14352 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; package Foo; use Struct::Dumb; struct Point => [qw( x y )]; package Bar; use Struct::Dumb; struct Point => [qw( x y z )]; package main; my $point2 = Foo::Point(10, 20); my $point3 = Bar::Point(10, 20, 30); ok( !$point2->can( "z" ), '$point2 cannot ->z' ); can_ok( $point3, "z" ); done_testing; Struct-Dumb-0.14/t/03readonly.t000444001750001750 46414371710300 15055 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; use Struct::Dumb qw( readonly_struct ); readonly_struct Point => [qw( x y )]; my $point = Point(10, 20); is( $point->x, 10, '$point->x is 10' ); ok( dies { $point->y = 30 }, '$point->y throws exception on readonly_struct' ); done_testing; Struct-Dumb-0.14/t/04named.t000444001750001750 240514371710300 14342 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; use Struct::Dumb; struct Colour => [qw( red green blue )], named_constructor => 1; { my $colour = Colour( red => 1, green => 0, blue => 0 ); can_ok( $colour, "red" ); is( $colour->red, 1, '$colour->red is 1' ); } { my $colour = Colour( green => 1, blue => 0.5, red => 0 ); is( $colour->blue, 0.5, '$colour->blue is 0.5' ); } { package named::default; use Struct::Dumb qw( -named_constructors ); struct Point3D => [qw( x y z )]; my $point = Point3D( x => 1, z => 3, y => 2 ); ::is( $point->z, 3, '$point->z from default named constructor' ); } like( dies { Colour( red => 0, green => 0 ) }, qr/^usage: main::Colour requires 'blue' at \S+ line \d+\.?\n/, 'Colour() without blue throws usage exception' ); like( dies { Colour( red => 0, green => 0, blue => 0, yellow => 1 ) }, qr/^usage: main::Colour does not recognise 'yellow' at \S+ line \d+\.?\n/, 'Colour() with yellow throws usage exception' ); { package named::optional; use Struct::Dumb; struct PointXY => [qw( x y ?z )], named_constructor => 1; my $point = PointXY( x => 1, y => 2 ); ::is( $point->z, undef, '$point->z from named constructor optional argument' ); } done_testing; Struct-Dumb-0.14/t/05predicate.t000444001750001750 43414371710300 15177 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; use Struct::Dumb; struct Point => [qw( x y )], predicate => "is_Point"; my $point = Point(10, 20); ok( is_Point( $point ), '$point is a Point' ); ok( !is_Point( [] ), 'unblessed ARRAYref is not a Point' ); done_testing; Struct-Dumb-0.14/t/10data-dump.t000444001750001750 107414371710300 15130 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; BEGIN { plan skip_all => "No Data::Dump" unless eval { require Data::Dump; }; Data::Dump->import( 'pp' ); } use Struct::Dumb; struct Point => [qw( x y )]; { my $point = Point( 10, 20 ); is( pp( $point ), 'main::Point(10, 20)', 'Data::Dump::pp can dump a Point' ); } struct PointX => [qw( x y )], named_constructor => 1; { is( pp( PointX( x => 30, y => 40 ) ), 'main::PointX(x => 30, y => 40)', 'Data::Dump::pp dumps named constructors with names' ); } done_testing; Struct-Dumb-0.14/t/11data-dump-late.t000444001750001750 60314371710300 16031 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test2::V0; use Struct::Dumb; BEGIN { plan skip_all => "No Data::Dump" unless eval { require Data::Dump; }; Data::Dump->import( 'pp' ); } struct Point => [qw( x y )]; { my $point = Point( 10, 20 ); is( pp( $point ), 'main::Point(10, 20)', 'Data::Dump::pp can dump a Point when loaded after' ); } done_testing; Struct-Dumb-0.14/t/99pod.t000444001750001750 25614371710300 14040 0ustar00leoleo000000000000#!/usr/bin/perl use strict; 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();