File Coverage

blib/lib/HEP/Names/LaTeX.pm

Criterion	Covered	Total	%
statement	25	25	100.0
branch	17	18	94.4
condition			n/a
subroutine	4	4	100.0
pod	1	1	100.0
total	47	48	97.9

use strict;
use warnings;

package HEP::Names::LaTeX;
$HEP::Names::LaTeX::VERSION = '0.01';
# ABSTRACT: formats plain names of high energy physics (HEP) particles to LaTeX


use Exporter qw( import );

our @EXPORT = qw( particle_to_latex );


my $names_to_escape = qr(psi|upsilon|gamma|tau|rho|pi|mu|eta|nu|omega);

sub particle_to_latex
{
	return '' unless @_;

	# in case of string literal in argument, we cannot modify @_!
	my @names = @_;
	foreach my $name ( @names ) {

		my ( $charge, $has_apo ) = ( '', '' );
		# this probably should be done better :)
		my $is_anti = $name =~ s/^anti-//;
		# charge is at last position (plus *)
		$charge = $1 if $name =~ s/(\**[0+-]+$)//;
		$has_apo = $1 if $name =~ s/('+)//;
		my $subscript = $1 if $name =~ s/_(.*)$//;

		my $total_charge = $has_apo.$charge;
		#$total_charge = undef unless length( $total_charge )

		# escape greek names
		$name =~ s/($names_to_escape)/\\$1/gi;
		$subscript =~ s/($names_to_escape)/\\$1/gi if $subscript;

		# ad put it together
		$name = "\\bar{$name}" if $is_anti;
		$name = $name."_{$subscript}" if $subscript;
		$name = $name."^{$total_charge}" if length($total_charge);
		$name = "\$".$name."\$";
	}

	return wantarray ? @names : $names[0];
}


1;

__END__