The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
bitflags-0.10
River stage zero No dependents
++
/ bitflags

NAME

bitflags - Perl module for generating bit flags

SYNOPSIS

  use bitflags qw( ALPHA BETA GAMMA DELTA );
  use bitflags qw( EPSILON ZETA ETA THETA );
  
  use bitflags qw( :start=2 BEE CEE DEE EEE EFF GEE );
  
  use bitflags qw( :start=^3 EIGHT SIXTEEN THIRTY_TWO );

DESCRIPTION

The bitflags module allows you to form a set of unique bit flags, for ORing together. Think of the O_ constants you get from Fcntl... that's the idea.

Successive calls remember the previous power used, so you don't have to set a starting number, or declare all the constants on one line.

If you do want to set a starting value, use the :start flag as the first argument in the import list. If the flag is :start=NNN, where NNN is some positive integer, that value is checked to ensure it's a power of two, and that value is used as the starting value. If it is not a power of two, the program will croak. If the flag is :start=^NNN, where NNN is some positive integer, that value is the power of two to start with.

Implementation

The flags are created as ()-prototyped functions in the caller's package, not unlike the constant pragma.

AUTHOR

Jeff "japhy" Pinyan.

URL: http://www.pobox.com/~japhy/

Email: japhy@pobox.com, PINYAN@cpan.org

CPAN ID: PINYAN

Online at: japhy on #perl on DALnet and EFnet. japhy at http://www.perlguru.com/. japhy at http://www.perlmonks.org/. "Coding With Style" column at http://www.perlmonth.com/.