File Coverage

blib/lib/Astro/App/Satpass2/Locale/C.pm

Criterion	Covered	Total	%
statement	20	20	100.0
branch			n/a
condition			n/a
subroutine	7	7	100.0
pod			n/a
total	27	27	100.0

package Astro::App::Satpass2::Locale::C;

use 5.008;

use strict;
use warnings;

use utf8;	# Not actually needed for C locale, but maybe for others

use Astro::Coord::ECI::TLE 0.059 qw{ :constants };
use Astro::App::Satpass2::Utils qw{ @CARP_NOT };
use Scalar::Util ();

our $VERSION = '0.057_01';

my @event_names;
$event_names[PASS_EVENT_NONE]		= '';
$event_names[PASS_EVENT_SHADOWED]	= 'shdw';
$event_names[PASS_EVENT_LIT]		= 'lit';
$event_names[PASS_EVENT_DAY]		= 'day';
$event_names[PASS_EVENT_RISE]		= 'rise';
$event_names[PASS_EVENT_MAX]		= 'max';
$event_names[PASS_EVENT_SET]		= 'set';
$event_names[PASS_EVENT_APPULSE]	= 'apls';
$event_names[PASS_EVENT_START]		= 'strt';
$event_names[PASS_EVENT_END]		= 'end';
$event_names[PASS_EVENT_BRIGHTEST]	= 'brgt';

my @sun_quarters = (
    'Spring equinox',
    'Summer solstice',
    'Autumn equinox',
    'Winter solstice',
);

# Any hash reference is a true value, but perlcritic seems not to know
# this.

{	## no critic (Modules::RequireEndWithOne)
    '+message'	=> {
    },
    '+template'	=> {

	# Local coordinates

	az_rng	=> <<'EOD',
[% data.azimuth( arg, bearing = 2 ) %]
    [%= data.range( arg ) -%]
EOD

	azel	=> <<'EOD',
[% data.elevation( arg ) %]
    [%= data.azimuth( arg, bearing = 2 ) -%]
EOD

	azel_rng	=> <<'EOD',
[% data.elevation( arg ) %]
    [%= data.azimuth( arg, bearing = 2 ) %]
    [%= data.range( arg ) -%]
EOD

	equatorial	=> <<'EOD',
[% data.right_ascension( arg ) %]
    [%= data.declination( arg ) -%]
EOD

	equatorial_rng	=> <<'EOD',
[% data.right_ascension( arg ) %]
    [%= data.declination( arg ) %]
    [%= data.range( arg ) -%]
EOD

	# Main templates

	almanac	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.almanac( arg ) %]
[%- END %]
[%- FOREACH item IN data %]
    [%- item.date %] [% item.time %]
        [%= item.almanac( units = 'description' ) %]
[% END -%]
EOD

	flare	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.flare( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- WHILE title.more_title_lines %]
    [%- title.time %]
        [%= title.name( width = 12 ) %]
        [%= title.local_coord %]
        [%= title.magnitude %]
        [%= title.angle( 'Degrees From Sun' ) %]
        [%= title.azimuth( 'Center Azimuth', bearing = 2 ) %]
        [%= title.range( 'Center Range', width = 6 ) %]

[%- END %]
[%- prior_date = '' -%]
[% FOR item IN data %]
    [%- center = item.center %]
    [%- current_date = item.date %]
    [%- IF prior_date != current_date %]
        [%- prior_date = current_date %]
        [%- current_date %]

    [%- END %]
    [%- item.time %]
        [%= item.name( units = 'title_case', width = 12 ) %]
        [%= item.local_coord %]
        [%= item.magnitude %]
        [%= IF 'day' == item.type( width = '' ) %]
            [%- item.appulse.angle %]
        [%- ELSE %]
            [%- item.appulse.angle( literal = 'night' ) %]
        [%- END %]
        [%= center.azimuth( bearing = 2 ) %]
        [%= center.range( width = 6 ) %]
[% END -%]
EOD

	list	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.list( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- WHILE title.more_title_lines %]
    [%- title.list %]
[% END %]
[%- FOR item IN data %]
    [%- item.list( arg ) %]
[% END -%]
EOD

	list_inertial	=> <<'EOD',
[% data.oid( align_left = 0, arg ) %] [% data.name( arg ) %]
    [%= data.epoch( arg ) %]
    [%= data.period( arg, align_left = 1 ) -%]
EOD

	list_fixed	=> <<'EOD',
[% data.oid( align_left = 0, arg ) %] [% data.name( arg ) %]
    [%= data.latitude( arg ) %]
    [%= data.longitude( arg ) %] [% data.altitude( arg ) -%]
EOD

	location	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.location( arg ) %]
[%- END -%]
[% localize( 'Location' ) %]: [% data.name( width = '' ) %]
          [% localize( 'Latitude' ) %] [% data.latitude( places = 4,
                width = '' ) %], [% localize( 'longitude' ) %]
            [%= data.longitude( places = 4, width = '' )
                %], [% localize( 'height' ) %]
            [%= data.altitude( units = 'meters', places = 0,
                width = '' ) %] m
EOD

	pass	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.pass( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- WHILE title.more_title_lines %]
    [%- format_detail( 'event', title ) %]

[%- END %]
[%- FOR pass IN data %]
    [%- events = pass.events %]
    [%- evt = events.first_tle %]

    [%- evt.date %]    [% evt.oid %] - [% evt.name( width = '' ) %]

    [%- FOREACH evt IN events %]
        [%- format_detail( 'event', evt ) %]

    [%- END %]
[%- END -%]
EOD
	'pass:event'	=> <<'EOD',
[%- evt.time %]
    [%= evt.local_coord %]
    [%= evt.latitude %]
    [%= evt.longitude %]
    [%= evt.altitude %]
    [%= evt.illumination %]
    [%- IF sp.want_pass_variant( 'brightest' ) %]
	[%= evt.magnitude %]
    [%- END %]
    [%= evt.event %]
EOD
	'pass:event:almanac'	=> <<'EOD',
[%- evt.time %]  [% evt.almanac %]
EOD
	'pass:event:apls'	=> <<'EOD',
[%- evt.time %]
    [%= evt.local_coord %]
    [%= evt.latitude %]
    [%= evt.longitude %]
    [%= evt.altitude %]
    [%= evt.illumination %]
    [%- IF sp.want_pass_variant( 'brightest' ) %]
	[%= evt.magnitude %]
    [%- END %]
    [%= evt.event %]
    [%- apls = evt.appulse %]

    [%- title.time( '' ) %]
	[%= apls.local_coord %]
	[%= apls.angle %] degrees from [% apls.name( width = '' ) %]
EOD

	pass_events	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.pass( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- WHILE title.more_title_lines %]
    [%- format_detail( 'event', title ) %]

[%- END %]
[%- FOREACH evt IN data.events %]
    [%- format_detail( 'event', evt ) %]
[% END -%]
EOD
	'pass_events:event'	=> <<'EOD',
[%- evt.date %] [% evt.time %]
    [%= evt.oid %] [% evt.event %]
    [%= evt.illumination %] [% evt.local_coord %]
EOD
	'pass_events:event:almanac'	=> <<'EOD',
[%- evt.date %] [% evt.time %] [% evt.almanac %]
EOD

	pass_ics	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.pass( arg ) %]
[%- END -%]
BEGIN:VCALENDAR
VERSION:2.0
[%- FOR pass IN data %]
[%- events = pass.events %]
[%- CALL events.fixed_width( 0 ) %]
[%- tle_events = pass.tle_events %]
[%- first = tle_events.first %]
[%- last = tle_events.last %]
[%- punct = '' %]
BEGIN:VEVENT
DTSTART:[% first.date( format = '%Y%m%dT%H%M%SZ', units = 'zulu' ) %]
BEGIN:VALARM
TRIGGER:-PT5M
ACTION:DISPLAY
END:VALARM
BEGIN:VALARM
TRIGGER:PT0M
ACTION:DISPLAY
END:VALARM
SUMMARY:[% first.name( width = '' ) %]
DESCRIPTION:
    [%- FOREACH evt IN events %][% punct %]
	[%- format_detail( 'event', evt ) %]
        [%- punct = '\n' %]
    [%- END %]
DTEND:[% last.date( format = '%Y%m%dT%H%M%SZ', units = 'z' ) %]
END:VEVENT
[%- END %]
END:VCALENDAR
EOD
	'pass_ics:event'		=> <<'EOD',
[%- evt.event %]
[%= evt.time %] [% localize( 'Az' ) %]
[%= evt.azimuth( places = 0, bearing = 2 ) %] [% localize( 'Ele' ) %]
[%= evt.elevation( places = 0 ) %]
[%- IF sp.want_pass_variant( 'brightest' ) && '' != evt.magnitude %]
    [%= localize( 'Mag' ) %] [% evt.magnitude %]
[%- END %]
EOD
	'pass_ics:event:almanac'	=> <<'EOD',
[%- evt.almanac %] [% evt.time %]
EOD
	'pass_ics:event:apls'		=> <<'EOD',
[%- evt.event %]
[%- appulse = evt.appulse %]
[%= appulse.angle %]
[%= appulse.name %]
[%= evt.time %] [% localize( 'Az' ) %]
[%= evt.azimuth( places = 0, bearing = 2 ) %]
[%= evt.elevation( places = 0 ) %]
[%- IF sp.want_pass_variant( 'brightest' ) && '' != evt.magnitude %]
    [%= localize( 'Mag' ) %] [% evt.magnitude %]
[%- END %]
EOD
	'pass_ics:event:rise'		=> <<'EOD',
[%- evt.event %]
[%= evt.time %] [% localize( 'Az' ) %]
[%= evt.azimuth( places = 0, bearing = 2 ) %]
[%- IF sp.want_pass_variant( 'brightest' ) && '' != evt.magnitude %]
    [%= localize( 'Mag' ) %] [% evt.magnitude %]
[%- END %]
EOD
	'pass_ics:event:set'		=> <<'EOD',
[%- evt.event %]
[%= evt.time %] [% localize( 'Az' ) %]
[%= evt.azimuth( places = 0, bearing = 2 ) %]
[%- IF sp.want_pass_variant( 'brightest' ) && '' != evt.magnitude %]
    [%= localize( 'Mag' ) %] [% evt.magnitude %]
[%- END %]
EOD

	phase	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.phase( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- WHILE title.more_title_lines %]
    [%- title.date( align_left = 0 ) %]
        [%= title.time( align_left = 0 ) %]
        [%= title.name( width = 8, align_left = 0 ) %]
        [%= title.phase( places = 0, width = 4 ) %]
        [%= title.phase( width = 16, units = 'phase',
            align_left = 1 ) %]
        [%= title.fraction_lit( title = 'Lit', places = 0, width = 4,
            units = 'percent', align_left = 0 ) %]

[%- END %]
[%- FOR item IN data %]
    [%- item.date %] [% item.time %]
        [%= item.name( width = 8, align_left = 0 ) %]
        [%= item.phase( places = 0, width = 4 ) %]
        [%= item.phase( width = 16, units = 'phase',
            align_left = 1 ) %]
        [%= item.fraction_lit( places = 0, width = 4,
            units = 'percent' ) %]%
[% END -%]
EOD

	position	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.position( arg ) %]
[%- END %]
[%- CALL title.title_gravity( TITLE_GRAVITY_BOTTOM ) %]
[%- data.date %] [% data.time %]
[%- WHILE title.more_title_lines %]
    [%- title.name( align_left = 0, width = 16 ) %]
        [%= title.local_coord %]
        [%= title.epoch( align_left = 0 ) %]
        [%= title.illumination %]

[%- END %]
[%- FOR item IN data.bodies() %]
    [%- item.name( width = 16, missing = 'oid', align_left = 0 ) %]
        [%= item.local_coord %]
        [%= item.epoch( align_left = 0 ) %]
        [%= item.illumination %]

    [%- FOR refl IN item.reflections() %]
        [%- item.name( literal = '', width = 16 ) %]
            [%= item.local_coord( literal = '' ) %] MMA
        [%- IF refl.status( width = '' ) %]
            [%= refl.mma( width = '' ) %] [% refl.status( width = '' ) %]
        [%- ELSE %]
            [%= refl.mma( width = '' ) %] mirror angle [%
                refl.angle( width = '' ) %] magnitude [%
                refl.magnitude( width = '' ) %]
        [%- END %]

    [%- END -%]
[% END -%]
EOD

	tle		=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.tle( arg ) %]
[%- END %]
[%- FOR item IN data %]
    [%- item.tle -%]
[% END -%]
EOD

	tle_json	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.tle( arg ) %]
[%- END %]
[%- data.bodies.to_json -%]
EOD

	# NOTE that templates that consist entirely of an outline-tag
	# INCLUDE are special-cased.
	tle_tle		=> '%% INCLUDE tle',

	tle_verbose	=> <<'EOD',
[% UNLESS data %]
    [%- SET data = sp.tle( arg ) %]
[%- END %]
[%- CALL title.fixed_width( 0 ) -%]
[% FOR item IN data -%]
[% UNLESS item.tle -%]
[% NEXT -%]
[% END -%]
[% CALL item.fixed_width( 0 ) -%]
[% title.oid %]: [% item.oid %]
    [% title.name %]: [% item.name %]
    [% title.international %]: [% item.international %]
    [% title.epoch %]: [% item.epoch( units = 'zulu' ) %] GMT
    [% title.effective_date %]: [%
        item.effective_date( units = 'zulu',
        missing = '' ) %] GMT
    [% title.classification %]: [% item.classification %]
    [% title.mean_motion %]: [% item.mean_motion( places = 8 )
        %] degrees/minute
    [% title.first_derivative %]: [%
        item.first_derivative( places = 8 ) %] degrees/minute squared
    [% title.second_derivative %]: [%
        item.second_derivative( places = 5 ) %] degrees/minute cubed
    [% title.b_star_drag %]: [% item.b_star_drag( places = 5 ) %]
    [% title.ephemeris_type %]: [% item.ephemeris_type %]
    [% title.inclination %]: [% item.inclination( places = 4 ) %] degrees
    [% title.ascending_node %]: [% item.ascending_node(
        places = 0 ) %] in right ascension
    [% title.eccentricity %]: [% item.eccentricity( places = 7 ) %]
    [% title.argument_of_perigee %]: [%
        item.argument_of_perigee( places = 4 )
        %] degrees from ascending node
    [% title.mean_anomaly %]: [%
        item.mean_anomaly( places = 4 ) %] degrees
    [% title.element_number %]: [% item.element_number %]
    [% title.revolutions_at_epoch %]: [% item.revolutions_at_epoch %]
    [% title.period %]: [% item.period %]
    [% title.semimajor %]: [% item.semimajor( places = 1 ) %] kilometers
    [% title.perigee %]: [% item.perigee( places = 1 ) %] kilometers
    [% title.apogee %]: [% item.apogee( places = 1 ) %] kilometers
[% END -%]
EOD
    },

    # By convention, -report_name is localizations of headings
    '-flare'	=> {
	string	=> {
	    'Degrees From Sun'	=> 'Degrees From Sun',
	    'Center Azimuth'	=> 'Center Azimuth',
	    'Center Range'	=> 'Center Range',
	    'night'		=> 'night',
	},
    },
    '-location'	=> {
	string	=> {
	    'Location'		=> 'Location',
	    'Latitude'		=> 'Latitude',
	    'longitude'		=> 'longitude',
	    'height'		=> 'height',
	},
    },
    '-pass_ics'	=> {
	string	=> {
	    'Az'	=> 'Az',
	    'Ele'	=> 'Ele',
	    'Mag'	=> 'Mag',
	},
    },

    almanac	=> {
	title	=> 'Almanac',
	Moon	=> {
	    horizon	=> [ 'Moon set', 'Moon rise' ],
	    quarter	=> [
			    'New Moon',
			    'First quarter Moon',
			    'Full Moon',
			    'Last quarter Moon',
	    ],
	    transit	=> [ undef, 'Moon transits meridian' ],
	},
	Sun	=> {
	    horizon	=> [ 'Sunset', 'Sunrise' ],
	    quarter	=> sub {
		my ( $key, $arg ) = @_;
		Scalar::Util::blessed( $arg )
		    and return $arg->__quarter_name( $key,
		    \@sun_quarters );
		return $sun_quarters[$key];
	    },
	    transit	=> [ 'local midnight', 'local noon' ],
	    twilight	=> [ 'end twilight', 'begin twilight' ],
	},
    },
    altitude	=> {
	title	=> 'Altitude',
    },
    angle	=> {
	title	=> 'Angle',
    },
    apoapsis	=> {
	title	=> 'Apoapsis',
    },
    apogee	=> {
	title	=> 'Apogee',
    },
    argument_of_perigee	=> {
	title	=> 'Argument Of Perigee',
    },
    ascending_node	=> {
	title	=> 'Ascending Node',
    },
    azimuth	=> {
	title	=> 'Azimuth',
    },
    bearing	=> {
	table	=> [
	    [ qw{ N E S W } ],
	    [ qw{ N NE E SE S SW W NW } ],
	    [ qw{ N NNE NE ENE E ESE SE SSE S SSW SW WSW W WNW NW
		NNW } ],
	],
    },
    b_star_drag	=> {
	title	=> 'B Star Drag',
    },
    classification	=> {
	title	=> 'Classification',
    },
    date	=> {
	title	=> 'Date',
    },
    declination	=> {
	title	=> 'Declination',
    },
    eccentricity	=> {
	title	=> 'Eccentricity',
    },
    effective_date	=> {
	title	=> 'Effective Date',
    },
    element_number	=> {
	title	=> 'Element Number',
    },
    elevation	=> {
	title	=> 'Elevation',
    },
    ephemeris_type	=> {
	title	=> 'Ephemeris Type',
    },
    epoch	=> {
	title	=> 'Epoch',
    },
    event	=> {
	table	=> [ @event_names ],
	title	=> 'Event',
    },
    first_derivative	=> {
	title	=> 'First Derivative',
    },
    fraction_lit	=> {
	title	=> 'Fraction Lit',
    },
    illumination	=> {
	title	=> 'Illumination',
    },
    inclination	=> {
	title	=> 'Inclination',
    },
    international	=> {
	title	=> 'International Launch Designator',
    },
    latitude	=> {
	title	=> 'Latitude',
    },
    longitude	=> {
	title	=> 'Longitude',
    },
    magnitude	=> {
	title	=> 'Magnitude',
    },
    maidenhead	=> {
	title	=> 'Maidenhead Grid Square',
    },
    mean_anomaly	=> {
	title	=> 'Mean Anomaly',
    },
    mean_motion	=> {
	title	=> 'Mean Motion',
    },
    mma	=> {
	title	=> 'MMA',
    },
    name	=> {
	title	=> 'Name',
	localize_value	=> {
	    Sun		=> 'Sun',
	    Moon	=> 'Moon',
	},
    },
    oid	=> {
	title	=> 'OID',
    },
    operational	=> {
	title	=> 'Operational',
    },
    periapsis	=> {
	title	=> 'Periapsis',
    },
    perigee	=> {
	title	=> 'Perigee',
    },
    period	=> {
	title	=> 'Period',
    },
    phase	=> {
	table	=> [
	    [ 6.1	=> 'new' ],
	    [ 83.9	=> 'waxing crescent' ],
	    [ 96.1	=> 'first quarter' ],
	    [ 173.9	=> 'waxing gibbous' ],
	    [ 186.1	=> 'full' ],
	    [ 263.9	=> 'waning gibbous' ],
	    [ 276.1	=> 'last quarter' ],
	    [ 353.9	=> 'waning crescent' ],
	],
	title	=> 'Phase',
    },
    range	=> {
	title	=> 'Range',
    },
    revolutions_at_epoch	=> {
	title	=> 'Revolutions At Epoch',
    },
    right_ascension	=> {
	title	=> 'Right Ascension',
    },
    second_derivative	=> {
	title	=> 'Second Derivative',
    },
    semimajor	=> {
	title	=> 'Semimajor Axis',
    },
    semiminor	=> {
	title	=> 'Semiminor Axis',
    },
    status	=> {
	title	=> 'Status',
    },
    time	=> {
	title	=> 'Time',
    },
    tle	=> {
	title	=> 'TLE',
    },
    type	=> {
	title	=> 'Type',
    },
};

__END__