enum-1.12/000755 000765 000024 00000000000 14102440520 012625 5ustar00neilbstaff000000 000000 enum-1.12/LICENSE000644 000765 000024 00000043660 14102440520 013643 0ustar00neilbstaff000000 000000 This software is copyright (c) 1998 by Byron Brummer. 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) 1998 by Byron Brummer. 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) 1998 by Byron Brummer. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End enum-1.12/Changes000644 000765 000024 00000007665 14102440520 014136 0ustar00neilbstaff000000 000000 Revision history for Perl module enum 1.12 2021-08-04 NEILB - Fixed documentation bug RT#132219, with PR#1 from JJ Atria. - Switched to Dist::Zilla 1.11 2015-10-27 NEILB - Updated github repo URL after changing my github username 1.10 2014-08-16 NEILB - Added min perl version (5.006) to enum.pm - Improved DESCRIPTION: reworded first paragraph to be a better summary, fixed formatting, and one typo. 1.09 2014-05-26 NEILB - Added some more modules to the SEE ALSO section - Various documentation improvements - Added github repo to the pod 1.08 2014-05-06 NEILB - Changed how the constants are defined, to deal with a change in 5.19.3 "Closures of the form "sub () { $some_variable }" are no longer inlined, causing changes to the variable to be ignored by callers of the subroutine. [perl #79908]" RT#95387 - thanks to Slaven Rezic. - Changed use of \d to [0-9] 1.07 2014-04-10 NEILB - Playing with Devel::Cover, starting to improve coverage of testsuite - Added testsuite for hex and octal index values, and _ in long numbers - Added testsuite for bitmask wrap-around cases 1.06 2014-01-25 NEILB - Specified MIN_PERL_VERSION as 5.006 in Makefile.PL - Changed the COPYRIGHT section to COPYRIGHT AND LICENSE so Kwalitee / CPANTS would see it. - Added 'warnings' to PREREQ_PM 1.05 2013-09-06 NEILB - I'd got two versions wrong when merging the history information from the pod into Changes. As a result the previous release was failing conformance with CPAN::Changes::Spec 1.04 2013-09-05 NEILB - Bumped version so I can release, now the offending CORBA-IDL release has been deleted from CPAN. 1.03 2013-09-02 NEILB - Added links to enumeration modules in SEE ALSO section. - Failed to index, due to clash with Enum module in CORBA-IDL 1.02 2013-09-01 NEILB - Added links to other modules and my review, in SEE ALSO - Failed to index, due to clash with PAUSE permissions for Enum module 1.016_01 2013-08-27 NEILB - Neil Bowers (NEILB) has taken over maintenance from Byron (thanks Byron!) - Reformatted this file (Changes) as per CPAN::Changes::Spec - Some of the revision history was in this file, some was in the pod; I think I've merged them correctly. - Added licence and repository metadata to Makefile.PL 1.016 1999-05-27 ZENIN - Fixed bug that caused bitwise operators to treat enum types as strings instead of numbers. - Last release by ZENIN (Byron Brummer) 1.015 1999-05-22 ZENIN - Add support for negative values. - Added stricter hex value checks. 1.014 1999-05-13 15:58:18 ZENIN - Added support for non-decimal numeric representations ala 0x123, 0644, and 123_456. - First version committed to CVS. - Fixed bug in hex index code that broke on 0xA. 1.013 1999-05-13 10:52:30 ZENIN - Fixed auto-index bugs in new non-decimal numeric support. 1.012 1999-05-13 10:00:45 ZENIN - Added support for non-decimal numeric representations ala 0x123, 0644, and 123_456. 1.011 1998-07-18 ZENIN - Added BITMASK and ENUM directives. - Revamped documentation. 1.010 1998-06-12 ZENIN - Removed test code - Released to CPAN 1.009 1998-06-11 ZENIN - Fixed -w warning when a null tag is used 1.008 1998-06-11 ZENIN - Fixed documentation bugs - Moved A..Z case to last as it's not going to be used as much as the other cases. 1.007 1998-06-10 ZENIN - Changed interface to match original design by Tom Phoenix as implemented in an early version of enum.pm by Benjamin Holzman. - Changed tag syntax to not require the 'PREFIX' string of Tom's interface. - Allow multiple prefix tags to be used at any point. - Allowed index value changes from tags. 1.006 1998-06-10 ZENIN - Fixed superfulous -w warning 1.004 1998-06-10 ZENIN - Changed behaver to closer resemble C enum types - Changed docs to match new behaver enum-1.12/MANIFEST000644 000765 000024 00000000440 14102440520 013754 0ustar00neilbstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.017. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README dist.ini lib/enum.pm t/06-non-decimal-indices.t t/07-bitmask-wraparound.t t/dot_dot.t t/new_index.t t/new_package.t t/new_tag.t t/simple_tags.t enum-1.12/t/000755 000765 000024 00000000000 14102440520 013070 5ustar00neilbstaff000000 000000 enum-1.12/README000644 000765 000024 00000001752 14102440520 013512 0ustar00neilbstaff000000 000000 The 'enum' module for Perl This module is used to efine a set of symbolic constants with ordered numeric values similar to enum types in the C programming language. Now capable of creating creating ordered bitmask constants as well. See the BITMASKS section for details. What are they good for? Typical uses would be for giving mnemonic names to indexes of arrays. Such arrays might be a list of months, days, or a return value index from a function such as localtime(): use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_=0 Sun Mon Tue Wed Thu Fri Sat :LC_=0 Sec Min Hour MDay Mon Year WDay YDay Isdst ); if ((localtime)[LC_Mon] == Months_Jan) { print "It's January!\n"; } if ((localtime)[LC_WDay] == Days_Fri) { print "It's Friday!\n"; } This not only reads easier, but can also be typo-checked at compile time when run under use strict. That is, if you misspell Days_Fri as Days_Fry, you'll generate a compile error. enum-1.12/META.yml000644 000765 000024 00000001445 14102440520 014102 0ustar00neilbstaff000000 000000 --- abstract: 'C style enumerated types and bitmask flags in Perl' author: - 'Byron Brummer ' build_requires: Test::More: '0.88' vars: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.017, 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: enum requires: Carp: '0' perl: '5.006' strict: '0' warnings: '0' resources: bugtracker: https://github.com/neilb/enum/issues homepage: https://github.com/neilb/enum repository: https://github.com/neilb/enum.git version: '1.12' x_generated_by_perl: v5.28.2 x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' enum-1.12/lib/000755 000765 000024 00000000000 14102440520 013373 5ustar00neilbstaff000000 000000 enum-1.12/Makefile.PL000644 000765 000024 00000002170 14102440520 014577 0ustar00neilbstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.017. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "C style enumerated types and bitmask flags in Perl", "AUTHOR" => "Byron Brummer ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "enum", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.006", "NAME" => "enum", "PREREQ_PM" => { "Carp" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "Test::More" => "0.88", "vars" => 0 }, "VERSION" => "1.12", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "Test::More" => "0.88", "strict" => 0, "vars" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); enum-1.12/META.json000644 000765 000024 00000002564 14102440520 014255 0ustar00neilbstaff000000 000000 { "abstract" : "C style enumerated types and bitmask flags in Perl", "author" : [ "Byron Brummer " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.017, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "enum", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "runtime" : { "requires" : { "Carp" : "0", "perl" : "5.006", "strict" : "0", "warnings" : "0" } }, "test" : { "requires" : { "Test::More" : "0.88", "vars" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/neilb/enum/issues" }, "homepage" : "https://github.com/neilb/enum", "repository" : { "type" : "git", "url" : "https://github.com/neilb/enum.git", "web" : "https://github.com/neilb/enum" } }, "version" : "1.12", "x_generated_by_perl" : "v5.28.2", "x_serialization_backend" : "Cpanel::JSON::XS version 4.24", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } enum-1.12/dist.ini000644 000765 000024 00000000450 14102440520 014270 0ustar00neilbstaff000000 000000 name = enum author = Byron Brummer license = Perl_5 copyright_holder = Byron Brummer copyright_year = 1998 version = 1.12 [@Filter] -bundle = @Basic -remove = Readme [PkgVersion] [AutoPrereqs] [MetaJSON] [GithubMeta] issues = 1 [Git::Tag] tag_message= [Git::Push] enum-1.12/lib/enum.pm000644 000765 000024 00000025212 14102440520 014677 0ustar00neilbstaff000000 000000 package enum; $enum::VERSION = '1.12'; use 5.006; use strict; use warnings; no strict 'refs'; # Let's just make this very clear right off use Carp; my $Ident = '[^\W_0-9]\w*'; sub ENUM () { 1 } sub BITMASK () { 2 } sub import { my $class = shift; @_ or return; # Ignore 'use enum;' my $pkg = caller() . '::'; my $prefix = ''; # default no prefix my $index = 0; # default start index my $mode = ENUM; # default to enum ## Pragmas should be as fast as they can be, so we inline some ## pieces. foreach (@_) { ## Plain tag is most common case if (/^$Ident$/o) { my $n = $index; if ($mode == ENUM) { $index++; } elsif ($mode == BITMASK) { $index ||= 1; $index *= 2; if ( $index & ($index - 1) ) { croak ( "$index is not a valid single bitmask " . " (Maybe you overflowed your system's max int value?)" ); } } else { confess qq(Can't Happen: mode $mode invalid); } *{"$pkg$prefix$_"} = eval "sub () { $n }"; } ## Index change elsif (/^($Ident)=(-?)(.+)$/o) { my $name= $1; my $neg = $2; $index = $3; ## Convert non-decimal numerics to decimal if ($index =~ /^0x[0-9a-f]+$/i) { ## Hex $index = hex $index; } elsif ($index =~ /^0[0-9]/) { ## Octal $index = oct $index; } elsif ($index !~ /[^0-9_]/) { ## 123_456 notation $index =~ s/_//g; } ## Force numeric context, but only in numeric context if ($index =~ /\D/) { $index = "$neg$index"; } else { $index = "$neg$index"; $index += 0; } my $n = $index; if ($mode == BITMASK) { ($index & ($index - 1)) and croak "$index is not a valid single bitmask"; $index *= 2; } elsif ($mode == ENUM) { $index++; } else { confess qq(Can't Happen: mode $mode invalid); } *{"$pkg$prefix$name"} = eval "sub () { $n }"; } ## Prefix/option change elsif (/^([A-Z]*):($Ident)?(=?)(-?)(.*)/) { ## Option change if ($1) { if ($1 eq 'ENUM') { $mode = ENUM; $index = 0 } elsif ($1 eq 'BITMASK') { $mode = BITMASK; $index = 1 } else { croak qq(Invalid enum option '$1') } } my $neg = $4; ## Index change too? if ($3) { if (length $5) { $index = $5; ## Convert non-decimal numerics to decimal if ($index =~ /^0x[0-9a-f]+$/i) { ## Hex $index = hex $index; } elsif ($index =~ /^0[0-9]/) { ## Oct $index = oct $index; } elsif ($index !~ /[^0-9_]/) { ## 123_456 notation $index =~ s/_//g; } ## Force numeric context, but only in numeric context if ($index =~ /[^0-9]/) { $index = "$neg$index"; } else { $index = "$neg$index"; $index += 0; } ## Bitmask mode must check index changes if ($mode == BITMASK) { ($index & ($index - 1)) and croak "$index is not a valid single bitmask"; } } else { croak qq(No index value defined after "="); } } ## Incase it's a null prefix $prefix = defined $2 ? $2 : ''; } ## A..Z case magic lists elsif (/^($Ident)\.\.($Ident)$/o) { ## Almost never used, so check last foreach my $name ("$1" .. "$2") { my $n = $index; if ($mode == BITMASK) { ($index & ($index - 1)) and croak "$index is not a valid single bitmask"; $index *= 2; } elsif ($mode == ENUM) { $index++; } else { confess qq(Can't Happen: mode $mode invalid); } *{"$pkg$prefix$name"} = eval "sub () { $n }"; } } else { croak qq(Can't define "$_" as enum type (name contains invalid characters)); } } } 1; __END__ =head1 NAME enum - C style enumerated types and bitmask flags in Perl =head1 SYNOPSIS use enum qw(Sun Mon Tue Wed Thu Fri Sat); # Sun == 0, Mon == 1, etc use enum qw(Forty=40 FortyOne Five=5 Six Seven); # Yes, you can change the start indexs at any time as in C use enum qw(:Prefix_ One Two Three); ## Creates Prefix_One, Prefix_Two, Prefix_Three use enum qw(:Letters_ A..Z); ## Creates Letters_A, Letters_B, Letters_C, ... use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_=0 Sun Mon Tue Wed Thu Fri Sat :Letters_=20 A..Z ); ## Prefixes can be changed mid list and can have index changes too use enum qw(BITMASK:LOCK_ SH EX NB UN); ## Creates bitmask constants for LOCK_SH == 1, LOCK_EX == 2, ## LOCK_NB == 4, and LOCK_UN == 8. ## NOTE: This example is only valid on FreeBSD-2.2.5 however, so don't ## actually do this. Import from Fnctl instead. =head1 DESCRIPTION This module is used to define a set of constants with ordered numeric values, similar to the C type in the C programming language. You can also define bitmask constants, where the value assigned to each constant has exactly one bit set (eg 1, 2, 4, 8, etc). What are enumerations good for? Typical uses would be for giving mnemonic names to indexes of arrays. Such arrays might be a list of months, days, or a return value index from a function such as localtime(): use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_=0 Sun Mon Tue Wed Thu Fri Sat :LC_=0 Sec Min Hour MDay Mon Year WDay YDay Isdst ); if ((localtime)[LC_Mon] == Months_Jan) { print "It's January!\n"; } if ((localtime)[LC_WDay] == Days_Fri) { print "It's Friday!\n"; } This not only reads easier, but can also be typo-checked at compile time when run under B. That is, if you misspell B as B, you'll generate a compile error. =head1 BITMASKS The B option allows the easy creation of bitmask constants such as functions like flock() and sysopen() use. These are also very useful for your own code as they allow you to efficiently store many true/false options within a single integer. use enum qw(BITMASK:MY_ FOO BAR CAT DOG); my $foo = 0; $foo |= MY_FOO; $foo |= MY_DOG; if ($foo & MY_DOG) { print "foo has the MY_DOG option set\n"; } if ($foo & (MY_BAR | MY_DOG)) { print "foo has either the MY_BAR or MY_DOG option set\n" } $foo ^= MY_DOG; ## Turn MY_DOG option off (set its bit to false) When using bitmasks, remember that you must use the bitwise operators, B<|>, B<&>, B<^>, and B<~>. If you try to do an operation like C<$foo += MY_DOG;> and the B bit has already been set, you'll end up setting other bits you probably didn't want to set. You'll find the documentation for these operators in the B manpage. You can set a starting index for bitmasks just as you can for normal B values. But if the given index isn't a power of 2, then it won't resolve to a single bit and therefore will generate a compile error. Because of this, whenever you set the B directive, the index is automatically set to 1. If you wish to go back to normal B mode, use the B directive. Similarly to the B directive, the B directive resets the index to 0. Here's an example: use enum qw( BITMASK:BITS_ FOO BAR CAT DOG ENUM: FALSE TRUE ENUM: NO YES BITMASK: ONE TWO FOUR EIGHT SIX_TEEN ); In this case, B equal 1, 2, 4 and 8 respectively. B equal 0 and 1. B also equal 0 and 1. And B equal, you guessed it, 1, 2, 4, 8, and 16. =head1 BUGS Enum names can not be the same as method, function, or constant names. This is probably a Good Thing[tm]. No way (that I know of) to cause compile time errors when one of these enum names get redefined. IMHO, there is absolutely no time when redefining a sub is a Good Thing[tm], and should be taken out of the language, or at least have a pragma that can cause it to be a compile time error. Enumerated types are package scoped just like constants, not block scoped as some other pragma modules are. It supports A..Z nonsense. Can anyone give me a Real World[tm] reason why anyone would ever use this feature...? =head1 SEE ALSO There are a number of modules that can be used to define enumerations: L, L, L, L, L, L. If you're using L, then L may be of interest. L is part of the L distribution. There are many CPAN modules related to defining constants in Perl; here are some of the best ones: L, L, L, L. Neil Bowers has written a L, which covers all such modules. =head1 REPOSITORY L =head1 AUTHOR Originally written by Byron Brummer (ZENIN), now maintained by Neil Bowers Eneilb@cpan.orgE. Based on early versions of the B module by Tom Phoenix. Original implementation of an interface of Tom Phoenix's design by Benjamin Holzman, for which we borrow the basic parse algorithm layout. =head1 COPYRIGHT AND LICENSE Copyright 1998 (c) Byron Brummer. Copyright 1998 (c) OMIX, Inc. Permission to use, modify, and redistribute this module granted under the same terms as Perl itself. =cut enum-1.12/t/new_index.t000644 000765 000024 00000001252 14102440520 015235 0ustar00neilbstaff000000 000000 use strict; use vars qw($test $ok $total); sub OK { print "ok " . $test++ . "\n" } sub NOT_OK { print "not ok " . $test++ . "\n"}; BEGIN { $test = 1; $ok=0; $| = 1 } END { NOT_OK unless $ok } use enum; $ok++; OK; use enum qw(Foo Bar Cat Dog); use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_ Sun=0 Mon Tue Wed Thu Fri Sat :Letters_=0 A..Z :=0 : A..Z Ten=10 Forty=40 FortyOne FortyTwo Zero=0 One Two Three=3 Four :=100 ); #2 (Zero != 0 or One != 1 or Two != 2 or Three != 3 or Four != 4) ? NOT_OK : OK; #3 (Ten != 10 or Forty != 40 or FortyOne != 41 or FortyTwo != 42) ? NOT_OK : OK; BEGIN { $total = 3; print "1..$total\n" } enum-1.12/t/dot_dot.t000644 000765 000024 00000001144 14102440520 014711 0ustar00neilbstaff000000 000000 use strict; use vars qw($test $ok $total); sub OK { print "ok " . $test++ . "\n" } sub NOT_OK { print "not ok " . $test++ . "\n"}; BEGIN { $test = 1; $ok=0; $| = 1 } END { NOT_OK unless $ok } use enum; $ok++; OK; use enum qw(Foo Bar Cat Dog); use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_ Sun=0 Mon Tue Wed Thu Fri Sat :Letters_=0 A..Z :=0 : A..Z Ten=10 Forty=40 FortyOne FortyTwo Zero=0 One Two Three=3 Four :=100 ); #2 (Letters_A != 0 or Letters_Z != 25) ? NOT_OK : OK; #3 (A != 0 or Z != 25) ? NOT_OK : OK; BEGIN { $total = 3; print "1..$total\n" } enum-1.12/t/06-non-decimal-indices.t000644 000765 000024 00000000414 14102440520 017301 0ustar00neilbstaff000000 000000 #!perl use strict; use warnings; use Test::More 0.88 tests => 3; use enum qw(EIGHT=010 FIFTEEN=0xf THOUSAND=1_000); ok(EIGHT == 8, "EIGHT should equal 8"); ok(FIFTEEN == 15, "FIFTEEN should equal 15"); ok(THOUSAND == 1000, "THOUSAND should equal 1000"); enum-1.12/t/07-bitmask-wraparound.t000644 000765 000024 00000001345 14102440520 017316 0ustar00neilbstaff000000 000000 #!perl use strict; use warnings; use Test::More 0.88 tests => 3; my $maxint; my $maxint_without_top_bit; BEGIN { $maxint = ~0; $maxint_without_top_bit = ~0; $maxint_without_top_bit >> 1; } eval qq{use enum "BITMASK:A=$maxint", 'B', 'C', 'D';}; ok(defined($@) && $@ =~ m!not a valid single bitmask!, "Starting a bitmask sequence at maxint should error on wrap-around"); eval qq{use enum "BITMASK:MASK_=$maxint", 'X', 'Y', 'Z';}; ok(defined($@) && $@ =~ m!not a valid single bitmask!, "Bitmask, with prefix, and maxint wraparound"); eval qq{use enum "BITMASK:MASK_=$maxint_without_top_bit", 'X', 'Y', 'Z';}; ok(defined($@) && $@ =~ m!not a valid single bitmask!, "Bitmask, where second symbol will become maxint"); enum-1.12/t/simple_tags.t000644 000765 000024 00000001403 14102440520 015562 0ustar00neilbstaff000000 000000 use strict; use vars qw($test $ok $total @foo); sub OK { print "ok " . $test++ . "\n" } sub NOT_OK { print "not ok " . $test++ . "\n"}; BEGIN { $test = 1; $ok=0; $| = 1 } END { NOT_OK unless $ok } use enum; $ok++; OK; use enum qw(Foo Bar Cat Dog); use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_ Sun=0 Mon Tue Wed Thu Fri Sat :Letters_=0 A..Z :=0 : A..Z Ten=10 Forty=40 FortyOne FortyTwo Zero=0 One Two Three=3 Four :=100 ); $foo[Foo] = "Foo"; $foo[Bar] = "Bar"; $foo[Cat] = "Cat"; $foo[Dog] = "Dog"; #2 (Foo != 0 or Bar != 1 or Cat != 2 or Dog != 3) ? NOT_OK : OK; #3 ($foo[Foo] ne "Foo" or $foo[Bar] ne "Bar" or $foo[Cat] ne "Cat" or $foo[Dog] ne "Dog") ? NOT_OK : OK; BEGIN { $total = 3; print "1..$total\n" } enum-1.12/t/new_package.t000644 000765 000024 00000001425 14102440520 015523 0ustar00neilbstaff000000 000000 use strict; use vars qw($test $ok $total @foo); sub OK { print "ok " . $test++ . "\n" } sub NOT_OK { print "not ok " . $test++ . "\n"}; BEGIN { $test = 1; $ok=0; $| = 1 } END { NOT_OK unless $ok } use enum; $ok++; OK; use enum qw(Foo Bar Cat Dog); use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_ Sun=0 Mon Tue Wed Thu Fri Sat :Letters_=0 A..Z :=0 : A..Z Ten=10 Forty=40 FortyOne FortyTwo Zero=0 One Two Three=3 Four :=100 ); $foo[Foo] = "Foo"; $foo[Bar] = "Bar"; $foo[Cat] = "Cat"; $foo[Dog] = "Dog"; { package main::F; use enum qw(Foo Bar Cat Dog); } if ( $foo[F::Foo] ne "Foo" or $foo[F::Bar] ne "Bar" or $foo[F::Cat] ne "Cat" or $foo[F::Dog] ne "Dog" ) { NOT_OK; } else { OK; } BEGIN { $total = 2; print "1..$total\n" } enum-1.12/t/new_tag.t000644 000765 000024 00000001162 14102440520 014701 0ustar00neilbstaff000000 000000 use strict; use vars qw($test $ok $total); sub OK { print "ok " . $test++ . "\n" } sub NOT_OK { print "not ok " . $test++ . "\n"}; BEGIN { $test = 1; $ok=0; $| = 1 } END { NOT_OK unless $ok } use enum; $ok++; OK; use enum qw(Foo Bar Cat Dog); use enum qw( :Months_=0 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec :Days_ Sun=0 Mon Tue Wed Thu Fri Sat :Letters_=0 A..Z :=0 : A..Z Ten=10 Forty=40 FortyOne FortyTwo Zero=0 One Two Three=3 Four :=100 ); #2 (Months_Apr != 3 or Months_Dec != 11) ? NOT_OK : OK; #3 (Days_Thu != 4 or Days_Sat != 6) ? NOT_OK : OK; BEGIN { $total = 3; print "1..$total\n" }