File Coverage

blib/lib/Types/PGPLOT.pm

Criterion	Covered	Total	%
statement	23	23	100.0
branch			n/a
condition			n/a
subroutine	8	8	100.0
pod			n/a
total	31	31	100.0

package Types::PGPLOT;

# ABSTRACT: Type::Tiny compatible types for the PGPLOT library

use 5.0100;

use strict;
use warnings;

our $VERSION = '0.02';

use Type::Library
  -base,
  -declare => qw[
  Angle
  ArrowHeadFillStyle
  CharacterHeight
  Color
  FillAreaStyle
  Font
  LineStyle
  LineWidth
  PlotUnits
  Symbol
  XAxisOptions
  YAxisOptions
];

use Types::Common::Numeric qw[ IntRange NumRange PositiveNum ];
use Types::Standard qw[ Str Dict ScalarRef ];
use Type::Utils -all;

# Package scoped hashes are made readonly so that we can allow their
# use outside of this module (e.g. for testing). Note however, that
# the common usage of $Map{$key} // $key will throw an exception if $Map{$key}
# does not exist.  Therefore, in code using the restricted hashes,
# always for check for existence before retrieving values.

use Readonly::Tiny;

#pod =type Angle
#pod
#pod A real number in [-360,360].
#pod
#pod =cut

declare Angle, as NumRange [ -360, 360 ];


#pod =type ArrowHeadFillStyle
#pod
#pod An integer in [1,2].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod   filled solid outline
#pod
#pod =cut

our %Map_AHFS = (
    solid   => 1,
    filled  => 1,
    outline => 2,
);

declare ArrowHeadFillStyle, as IntRange [ 1, 2 ];
coerce ArrowHeadFillStyle, from Str, via {
    $Map_AHFS{ lc $_ } // $_
};

readonly \%Map_AHFS;

#pod =type CharacterHeight
#pod
#pod A positive real number.
#pod
#pod =cut

declare CharacterHeight, as PositiveNum;


#pod =type Color
#pod
#pod An integer in [0,255].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod     background foreground
#pod     black      magenta         blue-magenta
#pod     white      yellow          red-magenta
#pod     red        orange          dark-gray
#pod     green      green-yellow    light-gray
#pod     blue       green-cyan      darkgray
#pod     cyan       blue-cyan       lightgray
#pod
#pod =cut

our %Map_Color = (
    background     => 0,
    black          => 0,
    foreground     => 1,
    white          => 1,
    red            => 2,
    green          => 3,
    blue           => 4,
    cyan           => 5,
    magenta        => 6,
    yellow         => 7,
    orange         => 8,
    'green-yellow' => 9,
    'green-cyan'   => 10,
    'blue-cyan'    => 11,
    'blue-magenta' => 12,
    'red-magenta'  => 13,
    'dark-gray'    => 14,
    'light-gray'   => 15,
    darkgray       => 14,
    lightgray      => 15,
);

readonly \%Map_Color;

declare Color, as IntRange [ 0, 255 ];

coerce Color, from Str,
  via { exists $Map_Color{ lc $_ } ? $Map_Color{ lc $_ } : $_ };



#pod =type FillAreaStyle
#pod
#pod An integer in [1,4].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod   solid filled outline hatched cross-hatched
#pod
#pod =cut

our %Map_FillAreaStyle = (
    solid           => 1,
    filled          => 1,
    outline         => 2,
    hatched         => 3,
    'cross-hatched' => 4,
);

readonly \%Map_FillAreaStyle;

declare FillAreaStyle, as IntRange [ 1, 4 ];
coerce FillAreaStyle, from Str,
  via { exists $Map_FillAreaStyle{ lc $_ } ? $Map_FillAreaStyle{ lc $_ } : $_ };


#pod =type Font
#pod
#pod An integer in [1,4].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod   normal roman italic script
#pod
#pod =cut

our %Map_Font = (
    normal => 1,
    roman  => 2,
    italic => 3,
    script => 4,
);

readonly \%Map_Font;

declare Font, as IntRange [ 1, 4 ];
coerce Font, from Str,
  via { exists $Map_Font{ lc $_ } ? $Map_Font{ lc $_ } : $_ };


#pod =type LineStyle
#pod
#pod An integer in [1,5].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod   full dashed dot-dash-dot-dash dotted dash-dot-dot-dot
#pod
#pod =cut

our %Map_LineStyle = (
    full                => 1,
    dashed              => 2,
    'dot-dash-dot-dash' => 3,
    dotted              => 4,
    'dash-dot-dot-dot'  => 5,
);

readonly \%Map_LineStyle;

declare LineStyle, as IntRange [ 1, 5 ];
coerce LineStyle, from Str,
  via { exists $Map_LineStyle{ lc $_ } ? $Map_LineStyle{ lc $_ } : $_ };


#pod =type LineWidth
#pod
#pod An integer in [1,201].
#pod
#pod =cut

declare LineWidth, as IntRange [ 1, 201 ];



#pod =type PlotUnits
#pod
#pod An integer in [0,4].
#pod
#pod Coercions are provided for Str types with one of the following values:
#pod
#pod   ndc normalized-device-coordinates
#pod   in inches
#pod   mm millimeters
#pod   pixels
#pod   wc world-coordinates
#pod
#pod =cut


our %Map_PlotUnits = (
    'normalized-device-coordinates' => 0,
    ndc                             => 0,
    inches                          => 1,
    in                              => 1,
    millimeters                     => 2,
    mm                              => 2,
    pixels                          => 3,
    'world-coordinates'             => 4,
    wc                              => 4,
);

readonly \%Map_PlotUnits;

declare PlotUnits, as IntRange [ 0, 4 ];
coerce PlotUnits, from Str,
  via { exists $Map_PlotUnits{ lc $_ } ? $Map_PlotUnits{ lc $_ } : $_ };


#pod =type Symbol
#pod
#pod An integer in [-31,255]
#pod
#pod Coercions are provided for string or references to strings with one of
#pod the following values:
#pod
#pod     doicosagon              dodecagon               triangle
#pod     henicosagon             hendecagon              dot0
#pod     icosagon                decagon                 dot1
#pod     enneadecagon            nonagon                 opensquare
#pod     octadecagon             enneagon                dot
#pod     heptadecagon            octagon                 plus
#pod     hexadecagon             heptagon                asterisk
#pod     pentaadecagon           hexagon                 opencircle
#pod     tetradecagon            pentagon                cross
#pod     tridecagon              diamond                 x
#pod     opensquare1             stardavid               opencirc4
#pod     opentriangle            square                  opencirc5
#pod     earth                   circle                  opencirc6
#pod     sun                     star                    opencirc7
#pod     curvesquare             bigosquare              backarrow
#pod     opendiamond             opencirc0               fwdarrow
#pod     openstar                opencirc1               uparrow
#pod     triangle1               opencirc2               downarrow
#pod     openplus                opencirc3
#pod
#pod as well as characters with unicode/ascii codes in [32, 127].
#pod
#pod Because Perl well treat digits stored as strings as numbers rather than
#pod strings, the characters C<0>, C<1>, C<2>, C<3>, C<4>, C<5>, C<6>, C<7>, C<8>, C<9>
#pod will get treated as integers, not characters, so the resultant symbols
#pod will not be the expected characters.  To ensure that a character is
#pod treated as a character, pass a reference to it.  This will bypass the
#pod automatic conversion to integer.
#pod
#pod =cut

our %Map_SymbolName = (
    doicosagon    => -22,
    henicosagon   => -21,
    icosagon      => -20,
    enneadecagon  => -19,
    octadecagon   => -18,
    heptadecagon  => -17,
    hexadecagon   => -16,
    pentaadecagon => -15,
    tetradecagon  => -14,
    tridecagon    => -13,
    dodecagon     => -12,
    hendecagon    => -11,
    decagon       => -10,
    nonagon       => -9,
    enneagon      => -9,
    octagon       => -8,
    heptagon      => -7,
    hexagon       => -6,
    pentagon      => -5,
    diamond       => -4,
    triangle      => -3,
    dot0          => -2,
    dot1          => -1,
    opensquare    => 0,
    dot           => 1,
    plus          => 2,
    asterisk      => 3,
    opencircle    => 4,
    cross         => 5,
    opensquare1   => 6,
    opentriangle  => 7,
    earth         => 8,
    sun           => 9,
    curvesquare   => 10,
    opendiamond   => 11,
    openstar      => 12,
    triangle1     => 13,
    openplus      => 14,
    stardavid     => 15,
    square        => 16,
    circle        => 17,
    star          => 18,
    bigosquare    => 19,
    opencirc0     => 20,
    opencirc1     => 21,
    opencirc2     => 22,
    opencirc3     => 23,
    opencirc4     => 24,
    opencirc5     => 25,
    opencirc6     => 26,
    opencirc7     => 27,
    backarrow     => 28,
    fwdarrow      => 29,
    uparrow       => 30,
    downarrow     => 31
);

readonly \%Map_SymbolName;

declare Symbol, as IntRange [ -31, 255 ];

coerce Symbol, from ScalarRef, via {
    return $_ unless 'SCALAR' eq ref $_;
    my $str = "$$_";

    my $name = lc $str;
    return $Map_SymbolName{ $name } if exists $Map_SymbolName{ $name };

    my $ord = ord( $str );
    return $ord > 31 && $ord < 128 ? $ord : $_;

};

coerce Symbol, from Str, via {

    my $name = lc $_;
    return $Map_SymbolName{ $name } if exists $Map_SymbolName{ $name };

    my $ord = ord( $_ );

    return $ord > 31 && $ord < 128 ? $ord : $_;
};


#pod =type XAxisOptions
#pod
#pod A string containing any of the characters in C<< ABCGILNPMTS12 >>, where no character repeats.
#pod
#pod =cut

declare XAxisOptions, as Str, where {
    $_ =~ /^(?:
                ( [ABCGILNPMTS12] )
                 (?!.*\g{-1})
             )+$
            /x;
};

#pod =type YAxisOptions
#pod
#pod A string containing any of the characters in C<< ABCGILNPMTSV12 >>, where no character repeats.
#pod
#pod =cut

declare YAxisOptions, as Str, where {
    $_ =~ /^(?:
                ( [ABCGILNPMTSV12] )
                 (?!.*\g{-1})
             )+$
            /x;
};

1;

#
# This file is part of Types-PGPLOT
#
# This software is Copyright (c) 2018 by Smithsonian Astrophysical Observatory.
#
# This is free software, licensed under:
#
#   The GNU General Public License, Version 3, June 2007
#

__END__