File Coverage

blib/lib/VIC/PIC/Any.pm

Criterion	Covered	Total	%
statement	54	80	67.5
branch	12	26	46.1
condition			n/a
subroutine	13	16	81.2
pod	1	8	12.5
total	80	130	61.5

package VIC::PIC::Any;
use strict;
use warnings;
use Carp;

our $VERSION = '0.31';
$VERSION = eval $VERSION;

use VIC::PIC::Gpsim;

# use this to map various PICs to their classes
# allows for the same class to be used for different pics
use constant PICS => {
    # PIC12
    P12F683 => 'P12F683',
    # PIC16
    P16F690 => 'P16F690',
    P16F631 => 'P16F631',
    P16F677 => 'P16F677',
    P16F685 => 'P16F685',
    P16F687 => 'P16F687',
    P16F689 => 'P16F689',
    P16F627A => 'P16F627A',
    P16F628A => 'P16F628A',
    P16F648A => 'P16F648A',
    # PIC18
    P18F242 => 'P18F242',
    P18F252 => 'P18F252',
    P18F442 => 'P18F442',
    P18F452 => 'P18F452',
    P18F13K50 => 'P18F13K50',
    P18F14K50 => 'P18F14K50',
    P18LF13K50 => 'P18LF13K50',
    P18LF14K50 => 'P18LF14K50',
};

use constant PICREGEX => {
    # PIC18
};

use constant SIMS => {
    gpsim => 'Gpsim',
};

sub _get_pic_type {
    my $type = shift;
    $type =~ s/^PIC/P/gi;
    my $ctype = PICS->{uc $type};
    unless (defined $ctype) {
        foreach my $regex (keys %{+PICREGEX}) {
            if ($type =~ $regex) {
                $ctype = PICREGEX->{$regex};
                last;
            }
        }
    }
    return $ctype;
}

sub new {
    my ($class, $type) = @_;
    if (uc $type eq 'ANY') {
        die "You need to specify the type of the chip on the commandline to use 'Any'\n";
        return;
    }
    my $ctype = &_get_pic_type($type);
    return unless defined $ctype;
    $class =~ s/::Any/::$ctype/g;
    eval "require $class;" or croak "Unable to load $class: $@";
    return $class->new(type => lc $ctype);
}

sub new_simulator {
    my ($class, %hh) = @_;
    my $stype = 'Gpsim';
    if (exists $hh{type}) {
        $stype = SIMS->{lc $hh{type}};
        unless (defined $stype) {
            carp "No simulator of type $hh{type}";
            return;
        }
    }
    $class =~ s/::Any/::$stype/g;
    $hh{type} = lc $stype;
    return $class->new(%hh);
}

sub supported_chips {
    my @chips = sort(keys %{+PICS});
    push @chips, sort(values %{+PICREGEX});
    return wantarray ? @chips : \@chips;
}

sub supported_simulators {
    my @sims = sort(keys %{+SIMS});
    return wantarray ? @sims : \@sims;
}

sub is_simulator_supported {
    my $ss = shift;
    my @sims = &supported_simulators();
    return (grep {/$ss/} @sims) ? 1 : 0;
}

sub is_chip_supported {
    my $chip = shift;
    my $ret = &_get_pic_type(uc $chip);
    return (defined $ret) ? 1 : 0;
}

sub list_chip_features {
    my $chip = shift;
    my $ctype = &_get_pic_type($chip);
    unless (defined $ctype) {
        carp "Chip $chip is not supported\n";
        return;
    }
    my $obj = __PACKAGE__->new($chip);
    my $roles = $obj->list_roles();
    return {
        roles => $roles,
        memory => $obj->memory,
    };
}

sub print_pinout {
    my $chip = shift;
    my $ctype = &_get_pic_type($chip);
    unless (defined $ctype) {
        carp "Chip $chip is not supported\n";
        return;
    }
    my $obj = __PACKAGE__->new($chip);
    return $obj->print_pinout;
}

1;

=encoding utf8

=head1 NAME

VIC::PIC::Any

=head1 SYNOPSIS

A wrapper class that returns the appropriate object for the given PIC
microcontroller name. This is used internally by VIC.

=head1 DESCRIPTION

=over

=item B

Returns an object for the given microcontroller name such as 'P16F690'.

=back

=head1 AUTHOR

Vikas N Kumar

=head1 COPYRIGHT

Copyright (c) 2014. Vikas N Kumar

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

See http://www.perl.com/perl/misc/Artistic.html

=cut