Getopt::Param::Tiny - Subset of Getopt::Param functionality with smaller memory footprint

Getopt-Param-Tiny documentation Contained in the Getopt-Param-Tiny distribution.

Index

Code Index:

NAME

Top

Getopt::Param::Tiny - Subset of Getopt::Param functionality with smaller memory footprint

VERSION

Top

This document describes Getopt::Param::Tiny version 0.5

SYNOPSIS

Top

    use Getopt::Param::Tiny;
    my $prm = Getopt::Param::Tiny->new();
    print "Starting..." if $prm->param('verbose');

DESCRIPTION

Top

Like Getopt::Param but using a simple hash based object instead of Class::Std, no localization for single error message, and only supplying the single, flexible, param() method.

INTERFACE

Top

new()

Same use as Getopt::Param's new.

param()

Same use as Getopt::Param's param.

help()

Same use as Getopt::Param's help.

DIAGNOSTICS

Top

See Getopt::Param's DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

Top

Getopt::Param::Tiny requires no configuration files or environment variables.

DEPENDENCIES

Top

None.

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

Please report any bugs or feature requests to bug-getopt-param-tiny@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Top

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

Top

Copyright (c) 2008, Daniel Muey <http://drmuey.com/cpan_contact.pl>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

Top

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

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 SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Getopt-Param-Tiny documentation Contained in the Getopt-Param-Tiny distribution. 
package Getopt::Param::Tiny;

use strict;
use vars qw($VERSION);
$VERSION = 0.5;

sub new {
    my ($self, $arg_ref) = @_;
    $self = bless {}, $self;
    
    $arg_ref->{'quiet'}  ||= 0;
    $arg_ref->{'strict'} ||= 0;
     
    my $args_ar         = ref $arg_ref->{'array_ref'} ne 'ARRAY' ? \@ARGV : $arg_ref->{'array_ref'};
    my @nodestruct      = @{ $args_ar };
    
    $self->{'opts'} = {};
    
    my $idx = 0;
    ARG_ITEM:
    for my $arg ( @nodestruct ) {
        last ARG_ITEM if $arg eq '--';
        
        my $rg = $arg_ref->{'strict'} ? qr{^--([^-])} : qr{^--(.)};
        
        if( $arg =~ s/$rg/$1/ ) {
            my($flag, $value) = split /=/, $arg, 2;
            push @{ $self->{'opts'}{ $flag } }, defined $value ? $value : '--' . $flag;
        }
        else {
            warn( sprintf('Argument %s did not match %s', $idx, $rg) ) if !$arg_ref->{'quiet'};
        }
        $idx++;
    }
    
    if( $self->{'opts'}{'help'} && $arg_ref->{'help_coderef'} ) {
         $arg_ref->{'help_coderef'}->($self);
    }

    $self->{'help_coderef'} = $arg_ref->{'help_coderef'} || sub { die( sprintf(q{No '%s' function defined}, 'help') ) };
    
    if ( !keys %{$self->{'opts'}} && $arg_ref->{'no_args_help'} ) {
        $self->{'help_coderef'}->($self);
    }
    
    if( ref $arg_ref->{'known_only'} eq 'ARRAY') {
        my %lookup;
        @lookup{ @{$arg_ref->{'known_only'}} } = ();
        
        my $unknown = 0;
        for my $k (keys %{$self->{'opts'}}) {
            if (!exists $lookup{$k}) {
                $unknown++;
                # $k =~ s{\W}{?}g; # or quotemeta()
                warn( sprintf(q{Unknown argument '%s'}, quotemeta($k)) );
            }
        }
        $self->{'help_coderef'}->($self) if $unknown;
    }
    
    if( ref $arg_ref->{'required'} eq 'ARRAY') {
        
        my $missing = 0;
        for my $k (@{$arg_ref->{'required'}}) {
            if (!exists $self->{'opts'}->{$k}) {
                $missing++;
                # $k =~ s{\W}{?}g; # or quotemeta()
                warn( sprintf(q{Missing argument '%s'}, quotemeta($k)) );
            }
        }
        $self->{'help_coderef'}->($self) if $missing;
    }
    
    if( ref $arg_ref->{'validate'} eq 'CODE') {
        $arg_ref->{'validate'}->($self) || $self->{'help_coderef'}->($self);
    }
    
    if ( ref $arg_ref->{'actions'} eq 'ARRAY' ) {
        for my $k ($arg_ref->{'actions'}) {
            if (exists $self->{'opts'}{$k->[0]}) {
                if (ref $k->[1] eq 'CODE') {
                    $k->[1]->($self);
                }
                else {
                    $self->{'help_coderef'}->($self);
                }
            }
        }
    }
        
    return $self;
}

sub help {
    my ($prm) = @_;
    $prm->{'help_coderef'}->($prm);
}

sub param {
    my ($self, $name, @val) = @_;
    return wantarray ? keys %{ $self->{'opts'} } : [ keys %{ $self->{'opts'} } ] if !$name;
    $self->{'opts'}{$name} = \@val if @val;
    return if !exists $self->{'opts'}{$name}; # do not auto vivify it
    return wantarray ? @{ $self->{'opts'}{$name} } : $self->{'opts'}{$name}->[0];    
}

1; 

__END__