# This -*- perl -*-  module is a simple parser for Adobe Font Metrics files.

package Font::AFM;

=head1 NAME

Font::AFM - Interface to Adobe Font Metrics files

=head1 SYNOPSIS

 use Font::AFM;

 $h = new Font::AFM "Helvetica";

 $copyright = $h->Notice;

 $w = $h->Wx->{"aring"};

 $w = $h->stringwidth("Gisle", 10);

 $h->dump;  # for debugging

=head1 DESCRIPTION

This module implements the Font::AFM class. Objects of this class are

initialised from an AFM (Adobe Font Metrics) file and allow you to obtain information

about the font and the metrics of the various glyphs in the font.

All measurements in AFM files are given in terms of units equal to

1/1000 of the scale factor of the font being used. To compute actual

sizes in a document, these amounts should be multiplied by (scale

factor of font)/1000.

The following methods are available:

=over 3

=item $afm = Font::AFM->new($fontname)

Object constructor. Takes the name of the font as argument.

Croaks if the font can not be found.

=item $afm->latin1_wx_table()

Returns a 256-element array, where each element contains the width

of the corresponding character in the iso-8859-1 character set.

=item $afm->stringwidth($string, [$fontsize])

Returns the width of the argument string. The string is

assumed to be encoded in the iso-8859-1 character set.  A second

argument can be used to scale the width according to the font size.

=item $afm->FontName

The name of the font as presented to the PostScript language

C<findfont> operator, for instance "Times-Roman".

=item $afm->FullName

Unique, human-readable name for an individual font, for instance

"Times Roman".

=item $afm->FamilyName

Human-readable name for a group of fonts that are stylistic variants

of a single design. All fonts that are members of such a group should

have exactly the same C<FamilyName>. Example of a family name is

"Times".

=item $afm->Weight

Human-readable name for the weight, or "boldness", attribute of a font.

Examples are C<Roman>, C<Bold>, C<Light>.

=item $afm->ItalicAngle

Angle in degrees counterclockwise from the vertical of the dominant

vertical strokes of the font.

=item $afm->IsFixedPitch

If C<true>, the font is a fixed-pitch

(monospaced) font.

=item $afm->FontBBox

A string of four numbers giving the lower-left x, lower-left y,

upper-right x, and upper-right y of the font bounding box. The font

bounding box is the smallest rectangle enclosing the shape that would

result if all the characters of the font were placed with their

origins coincident, and then painted.

=item $afm->UnderlinePosition

Recommended distance from the baseline for positioning underline

strokes. This number is the y coordinate of the center of the stroke.

=item $afm->UnderlineThickness

Recommended stroke width for underlining.

=item $afm->Version

Version number of the font.

=item $afm->Notice

Trademark or copyright notice, if applicable.

=item $afm->Comment

Comments found in the AFM file.

=item $afm->EncodingScheme

The name of the standard encoding scheme for the font. Most Adobe

fonts use the C<AdobeStandardEncoding>. Special fonts might state

C<FontSpecific>.

=item $afm->CapHeight

Usually the y-value of the top of the capital H.

=item $afm->XHeight

Typically the y-value of the top of the lowercase x.

=item $afm->Ascender

Typically the y-value of the top of the lowercase d.

=item $afm->Descender

Typically the y-value of the bottom of the lowercase p.

=item $afm->Wx

Returns a hash table that maps from glyph names to the width of that glyph.

=item $afm->BBox

Returns a hash table that maps from glyph names to bounding box information.

The bounding box consist of four numbers: llx, lly, urx, ury.

=item $afm->dump

Dumps the content of the Font::AFM object to STDOUT.  Might sometimes

be useful for debugging.

=back

The AFM specification can be found at:

   http://partners.adobe.com/asn/developer/pdfs/tn/5004.AFM_Spec.pdf

=head1 ENVIRONMENT

=over 10

=item METRICS

Contains the path to search for AFM-files.  Format is as for the PATH

environment variable. The default path built into this library is:

 /usr/lib/afm:/usr/local/lib/afm:/usr/openwin/lib/fonts/afm/:.

=back

=head1 BUGS

Kerning data and composite character data are not yet parsed.

Ligature data is not parsed.

=head1 COPYRIGHT

Copyright 1995-1998 Gisle Aas. All rights reserved.

This program is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.

=cut

#-------perl resumes here--------------------------------------------

use Carp;

use strict;

use vars qw($VERSION @ISOLatin1Encoding);

$VERSION = "1.20";

# The metrics_path is used to locate metrics files

#

my $metrics_path = $ENV{METRICS} ||

    "/usr/lib/afm:/usr/local/lib/afm:/usr/openwin/lib/fonts/afm/:.";

my @metrics_path = split(/:/, $metrics_path);

foreach (@metrics_path) { s,/$,, }    # reove trailing slashes

@ISOLatin1Encoding = qw(

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef space

 exclam quotedbl numbersign dollar percent ampersand quoteright

 parenleft parenright asterisk plus comma minus period slash zero one

 two three four five six seven eight nine colon semicolon less equal

 greater question at A B C D E F G H I J K L M N O P Q R S

 T U V W X Y Z bracketleft backslash bracketright asciicircum

 underscore quoteleft a b c d e f g h i j k l m n o p q r s

 t u v w x y z braceleft bar braceright asciitilde .notdef .notdef

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef .notdef

 .notdef .notdef .notdef .notdef .notdef .notdef .notdef dotlessi grave

 acute circumflex tilde macron breve dotaccent dieresis .notdef ring

 cedilla .notdef hungarumlaut ogonek caron space exclamdown cent

 sterling currency yen brokenbar section dieresis copyright ordfeminine

 guillemotleft logicalnot hyphen registered macron degree plusminus

 twosuperior threesuperior acute mu paragraph periodcentered cedilla

 onesuperior ordmasculine guillemotright onequarter onehalf threequarters

 questiondown Agrave Aacute Acircumflex Atilde Adieresis Aring AE

 Ccedilla Egrave Eacute Ecircumflex Edieresis Igrave Iacute Icircumflex

 Idieresis Eth Ntilde Ograve Oacute Ocircumflex Otilde Odieresis

 multiply Oslash Ugrave Uacute Ucircumflex Udieresis Yacute Thorn

 germandbls agrave aacute acircumflex atilde adieresis aring ae

 ccedilla egrave eacute ecircumflex edieresis igrave iacute icircumflex

 idieresis eth ntilde ograve oacute ocircumflex otilde odieresis divide

 oslash ugrave uacute ucircumflex udieresis yacute thorn ydieresis

);

# Creates a new Font::AFM object.  Pass it the name of the font as parameter.

# Synopisis:

#

#    $h = new Font::AFM "Helvetica";

#

sub new

{

   my($class, $fontname) = @_;

   my $file;

   $fontname =~ s/\.afm$//;

   if ($^O eq 'VMS') {

       $file = "sys\$ps_font_metrics:$fontname.afm";

   } else {

       $file = "$fontname.afm";

       unless ($file =~ m,^/,) {

	   # not absolute, search the metrics path for the file

	   foreach (@metrics_path) {

	       if (-f "$_/$file") {

		   $file = "$_/$file";

		   last;

	       }

	   }

       }

   }

   open(AFM, $file) or croak "Can't find the AFM file for $fontname";

   my $self = bless { }, $class;

   local($/, $_) = ("\n", undef);  # ensure correct $INPUT_RECORD_SEPARATOR

   while (<AFM>) {

       next if /^StartKernData/ .. /^EndKernData/;  # kern data not parsed yet

       next if /^StartComposites/ .. /^EndComposites/; # same for composites

       if (/^StartCharMetrics/ .. /^EndCharMetrics/) {

	   # only lines that start with "C" or "CH" are parsed

	   next unless /^CH?\s/;

	   my($name) = /\bN\s+(\.?\w+)\s*;/;

	   my($wx)   = /\bWX\s+(\d+)\s*;/;

	   my($bbox)    = /\bB\s+([^;]+);/;

	   $bbox =~ s/\s+$//;

	   # Should also parse lingature data (format: L successor lignature)

	   $self->{'wx'}{$name} = $wx;

	   $self->{'bbox'}{$name} = $bbox;

	   next;

       }

       last if /^EndFontMetrics/;

       if (/(^\w+)\s+(.*)/) {

	   my($key,$val) = ($1, $2);

	   $key = lc $key;

	   if (defined $self->{$key}) {

	       $self->{$key} = [ $self->{$key} ] unless ref $self->{$key};

	       push(@{$self->{$key}}, $val);

	   } else {

	       $self->{$key} = $val;

	   }

       } else {

	   print STDERR "Can't parse: $_";

       }

   }

   close(AFM);

   unless (exists $self->{wx}->{'.notdef'}) {

       $self->{wx}->{'.notdef'} = 0;

       $self->{bbox}{'.notdef'} = "0 0 0 0";

   }

   $self;

}

# Returns an 256 element array that maps from characters to width

sub latin1_wx_table

{

    my($self) = @_;

    unless ($self->{'_wx_table'}) {

	my @wx;

	for (0..255) {

	    my $name = $ISOLatin1Encoding[$_];

	    if (exists $self->{wx}->{$name}) {

		push(@wx, $self->{wx}->{$name})

	    } else {

		push(@wx, $self->{wx}->{'.notdef'});

	    }

	}

	$self->{'_wx_table'} = \@wx;

    }

    wantarray ? @{ $self->{'_wx_table'} } : $self->{'_wx_table'};

}

sub stringwidth

{

    my($self, $string, $pointsize) = @_;

    return 0.0 unless defined $string;

    return 0.0 unless length $string;

    my @wx = $self->latin1_wx_table;

    my $width = 0.0;

    for (unpack("C*", $string)) {

	$width += $wx[$_];

    }

    if ($pointsize) {

	$width *= $pointsize / 1000;

    }

    $width;

}

sub FontName;

sub FullName;

sub FamilyName;

sub Weight;

sub ItalicAngle;

sub IsFixedPitch;

sub FontBBox;

sub UnderlinePosition;

sub UnderlineThickness;

sub Version;

sub Notice;

sub Comment;

sub EncodingScheme;

sub CapHeight;

sub XHeight;

sub Ascender;

sub Descender;

sub Wx;

sub BBox;

# We implement all the access functions within this simple autoload

# function.

sub AUTOLOAD

{

    no strict 'vars';  # don't want to declare $AUTOLOAD

    #print "AUTOLOAD: $AUTOLOAD\n";

    if ($AUTOLOAD =~ /::DESTROY$/) {

	eval "sub $AUTOLOAD {}";

	goto &$AUTOLOAD;

    } else {

	my $name = $AUTOLOAD;

	$name =~ s/^.*:://;

	croak "Attribute $name not defined for AFM object"

	    unless defined $_[0]->{lc $name};

	return $_[0]->{lc $name};

    }

}

# Dumping might be useful for debugging

sub dump

{

    my($self) = @_;

    my($key, $val);

    foreach $key (sort keys %$self) {

	if (ref $self->{$key}) {

	    if (ref $self->{$key} eq "ARRAY") {

		print "$key = [\n\t", join("\n\t", @{$self->{$key}}), "\n]\n";

	    } elsif (ref $self->{$key} eq "HASH") {

		print "$key = {\n";

		my $key2;

		foreach $key2 (sort keys %{$self->{$key}}) {

		    print "\t$key2 => $self->{$key}{$key2},\n";

		}

		print "}\n";

	    } else {

		print "$key = $self->{$key}\n";

	    }

	} else {

	    print "$key = $self->{$key}\n";

	}

    }

}

1;