File Coverage

blib/lib/PGPLOTx/Constants.pm

Criterion	Covered	Total	%
statement	23	23	100.0
branch	4	6	66.6
condition	8	12	66.6
subroutine	8	8	100.0
pod			n/a
total	43	49	87.7

package PGPLOTx::Constants;

# ABSTRACT: Constants for use with PGPLOT

use strict;
use warnings;

use CXC::Exporter::Util ':all';
use parent 'Exporter::Tiny';

#<<<
our $VERSION = '0.01'; # TRIAL
#>>>

install_CONSTANTS( {

        ARROWHEAD_FILL_STYLES => {
            SOLID   => 1,
            FILLED  => 1,
            OUTLINE => 2,
        },

        COLORS => {
            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,
        },

        AREA_FILL_STYLES => {
            SOLID         => 1,
            FILLED        => 1,
            OUTLINE       => 2,
            HATCHED       => 3,
            CROSS_HATCHED => 4,
        },

        FONTS => {
            NORMAL => 1,
            ROMAN  => 2,
            ITALIC => 3,
            SCRIPT => 4,
        },

        LINE_STYLES => {
            FULL              => 1,
            DASHED            => 2,
            DOT_DASH_DOT_DASH => 3,
            DOTTED            => 4,
            DASH_DOT_DOT_DOT  => 5,
        },

        PLOT_UNITS => {
            NORMALIZED_DEVICE_COORDINATES => 0,
            NDC                           => 0,
            INCHES                        => 1,
            IN                            => 1,
            MILLIMETERS                   => 2,
            MM                            => 2,
            PIXELS                        => 3,
            WORLD_COORDINATES             => 4,
            WC                            => 4,
        },

        SYMBOLS => {
            DOICOSAGON   => -22,
            HENICOSAGON  => -21,
            ICOSAGON     => -20,
            ENNEADECAGON => -19,
            OCTADECAGON  => -18,
            HEPTADECAGON => -17,
            HEXADECAGON  => -16,
            PENTADECAGON => -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
        },

        XAXIS_OPTIONS => { map { ( "XAXIS_OPT_$_" => $_ ) } qw( A B C G I L N P M T S ) },

        YAXIS_OPTIONS => { map { ( "YAXIS_OPT_$_" => $_ ) } qw( A B C G I L N P M T S V ) },
    } );

install_EXPORTS;

sub _exporter_validate_opts {
    my ( $class, $globals ) = @_;

    if ( exists $globals->{as} && !ref $globals->{as} && $globals->{as} eq 'lc' ) {
        $globals->{as} = sub { lc $_[0] }
    }
}

sub _exporter_merge_opts {
    my ( $class, $tag_opts, $global_opts, @stuff ) = @_;

    $tag_opts = {} unless ref( $tag_opts ) eq q(HASH);
    if ( exists $tag_opts->{-as} && !ref $tag_opts->{-as} && $tag_opts->{-as} eq 'lc' ) {
        $tag_opts = { %{$tag_opts}, -as => sub { lc $_[0] } };
    }

    $class->SUPER::_exporter_merge_opts( $tag_opts, $global_opts, @stuff );
}

1;

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

__END__