File Coverage

blib/lib/Finnigan/RunHeader.pm

Criterion	Covered	Total	%
statement	54	60	90.0
branch	7	14	50.0
condition			n/a
subroutine	16	18	88.8
pod	14	14	100.0
total	91	106	85.8

package Finnigan::RunHeader;

use strict;
use warnings FATAL => qw( all );
our $VERSION = 0.0206;

use Finnigan;
use base 'Finnigan::Decoder';


sub decode {
  my ($class, $stream, $version) = @_;

  my @common_fields = (
                       "sample info" => ['object', 'Finnigan::SampleInfo'],
                      );

  my %specific_fields;
  $specific_fields{8} = [
                         "orig file name"   => ['varstr', 'PascalStringWin32'],
                         "file name[1]"  => ['varstr', 'PascalStringWin32'],
                         "file name[2]"  => ['varstr', 'PascalStringWin32'],
                         "file name[3]"  => ['varstr', 'PascalStringWin32'],
                        ];

  $specific_fields{57} = [
                          "file name[1]"          => ['U0C520', 'UTF16LE'],
                          "file name[2]"          => ['U0C520', 'UTF16LE'],
                          "file name[3]"          => ['U0C520', 'UTF16LE'],
                          "file name[4]"          => ['U0C520', 'UTF16LE'],
                          "file name[5]"          => ['U0C520', 'UTF16LE'],
                          "file name[6]"          => ['U0C520', 'UTF16LE'],
                          "unknown double[1]"     => ['d<',     'Float64'],
                          "unknown double[2]"     => ['d<',     'Float64'],
                          "file name[7]"          => ['U0C520', 'UTF16LE'],
                          "file name[8]"          => ['U0C520', 'UTF16LE'],
                          "file name[9]"          => ['U0C520', 'UTF16LE'],
                          "file name[a]"          => ['U0C520', 'UTF16LE'],
                          "file name[b]"          => ['U0C520', 'UTF16LE'],
                          "file name[c]"          => ['U0C520', 'UTF16LE'],
                          "file name[d]"          => ['U0C520', 'UTF16LE'],
                          "scan trailer addr"     => ['V',      'UInt32'],
                          "scan params addr"      => ['V',      'UInt32'],
                          "unknown length[1]"     => ['V',      'UInt32'],
                          "unknown length[2]"     => ['V',      'UInt32'],
                          "nsegs"                 => ['V',      'UInt32'],
                          "unknown long[1]"       => ['V',      'UInt32'],
                          "unknown long[2]"       => ['V',      'UInt32'],
                          "own addr"              => ['V',      'UInt32'],
                          "unknown long[3]"       => ['V',      'UInt32'],
                          "unknown long[4]"       => ['V',      'UInt32'],
                         ];

  $specific_fields{60} = $specific_fields{57};
  $specific_fields{62} = $specific_fields{57};
  $specific_fields{63} = $specific_fields{57};

  $specific_fields{64} = [
                          "file name[1]"          => ['U0C520', 'UTF16LE'],
                          "file name[2]"          => ['U0C520', 'UTF16LE'],
                          "file name[3]"          => ['U0C520', 'UTF16LE'],
                          "file name[4]"          => ['U0C520', 'UTF16LE'],
                          "file name[5]"          => ['U0C520', 'UTF16LE'],
                          "file name[6]"          => ['U0C520', 'UTF16LE'],
                          "unknown double[1]"     => ['d<',     'Float64'],
                          "unknown double[2]"     => ['d<',     'Float64'],
                          "file name[7]"          => ['U0C520', 'UTF16LE'],
                          "file name[8]"          => ['U0C520', 'UTF16LE'],
                          "file name[9]"          => ['U0C520', 'UTF16LE'],
                          "file name[a]"          => ['U0C520', 'UTF16LE'],
                          "file name[b]"          => ['U0C520', 'UTF16LE'],
                          "file name[c]"          => ['U0C520', 'UTF16LE'],
                          "file name[d]"          => ['U0C520', 'UTF16LE'],
                          "32-bit scan trailer addr (defunct)"     => ['V',      'UInt32'],
                          "32-bit scan params addr (defunct)"      => ['V',      'UInt32'],
                          "unknown length[1]"     => ['V',      'UInt32'],
                          "unknown length[2]"     => ['V',      'UInt32'],
                          "nsegs"                 => ['V',      'UInt32'],
                          "unknown long[1]"       => ['V',      'UInt32'],
                          "unknown long[2]"       => ['V',      'UInt32'],
                          "32-bit own addr (defunct)"              => ['V',      'UInt32'],
                          "unknown long[3]"       => ['V',      'UInt32'],
                          "unknown long[4]"       => ['V',      'UInt32'],

			  "scan index addr"       => ['Q<',     'Uint64'],
			  "data addr"             => ['Q<',     'Uint64'],
			  "inst log addr"         => ['Q<',     'Uint64'],
			  "error log addr"        => ['Q<',     'Uint64'],
			  "unknown addr[1]"       => ['Q<',     'Uint64'],
			  "scan trailer addr"     => ['Q<',     'Uint64'],
			  "scan params addr"      => ['Q<',     'Uint64'],
			  "unknown addr[2]"       => ['Q<',     'Uint64'],
			  "own addr"              => ['Q<',     'Uint64'],

                          "unknown long[5]"       => ['V',      'UInt32'],
                          "unknown long[6]"       => ['V',      'UInt32'],
                          "unknown long[7]"       => ['V',      'UInt32'],
                          "unknown long[8]"       => ['V',      'UInt32'],
                          "unknown long[9]"       => ['V',      'UInt32'],
                          "unknown long[10]"      => ['V',      'UInt32'],
                          "unknown long[11]"      => ['V',      'UInt32'],
                          "unknown long[12]"      => ['V',      'UInt32'],
                          "unknown long[13]"      => ['V',      'UInt32'],
                          "unknown long[14]"      => ['V',      'UInt32'],
                          "unknown long[15]"      => ['V',      'UInt32'],
                          "unknown long[16]"      => ['V',      'UInt32'],
                          "unknown long[17]"      => ['V',      'UInt32'],
                          "unknown long[18]"      => ['V',      'UInt32'],
                          "unknown long[19]"      => ['V',      'UInt32'],
                          "unknown long[20]"      => ['V',      'UInt32'],
                          "unknown long[21]"      => ['V',      'UInt32'],
                          "unknown long[22]"      => ['V',      'UInt32'],
                          "unknown long[23]"      => ['V',      'UInt32'],
                          "unknown long[24]"      => ['V',      'UInt32'],
                          "unknown long[25]"      => ['V',      'UInt32'],
                          "unknown long[26]"      => ['V',      'UInt32'],
                          "unknown long[27]"      => ['V',      'UInt32'],
                          "unknown long[28]"      => ['V',      'UInt32'],
                         ];
  $specific_fields{66} = $specific_fields{64};

  die "don't know how to parse version $version" unless $specific_fields{$version};
  my $self = Finnigan::Decoder->read($stream, [@common_fields, @{$specific_fields{$version}}]);
  $self->{version} = $version;

  return bless $self, $class;
}

sub sample_info {
  shift->{data}->{"sample info"}->{value};
}

sub self_addr {
  shift->{data}->{"own addr"}->{value};
}

sub trailer_addr {
  shift->{data}->{"scan trailer addr"}->{value};
}

sub params_addr {
  shift->{data}->{"scan params addr"}->{value};
}

sub scan_index_addr {
  my $self = shift;
  if ($self->{version} >= 64 ) {
    return $self->{data}->{"scan index addr"}->{value};
  }
  else {
    return $self->sample_info->{data}->{"scan index addr"}->{value};
  }
}

sub data_addr {
  my $self = shift;
  if ($self->{version} >= 64 ) {
    return $self->{data}->{"data addr"}->{value};
  }
  else {
    return $self->sample_info->{data}->{"data addr"}->{value};
  }
}

sub inst_log_addr {
  my $self = shift;
  if ($self->{version} >= 64 ) {
    return $self->{data}->{"inst log addr"}->{value};
  }
  else {
    return $self->sample_info->{data}->{"inst log addr"}->{value};
  }
}

sub error_log_addr {
  my $self = shift;
  if ($self->{version} >= 64 ) {
    return $self->{data}->{"error log addr"}->{value};
  }
  else {
    return $self->sample_info->{data}->{"error log addr"}->{value};
  }
}

sub ntrailer {
  my $self = shift;
  my $l1 = $self->{data}->{"unknown length[1]"}->{value};
  my $l2 = $self->{data}->{"unknown length[2]"}->{value};
  die "It\'s a happy day! We\'ve run into a case where the two lengths differ: l1 = $l1 and l2 = $l2"
    unless $l1 = $l2;

  # I am assuming it is the length of TrailerScanEvent
  return $l1;
}

sub nparams {
  my $self = shift;
  my $l1 = $self->{data}->{"unknown length[1]"}->{value};
  my $l2 = $self->{data}->{"unknown length[2]"}->{value};
  die "It\'s a happy day! We\'ve run into a case where the two lengths differ: l1 = $l1 and l2 = $l2"
    unless $l1 = $l2;

  # I am assuming it is the length of ScanParams
  return $l2;
}

sub nsegs {
  shift->{data}->{"nsegs"}->{value};
}

sub u1 {
  shift->{data}->{"unknown double[1]"}->{value};
}

sub u2 {
  shift->{data}->{"unknown double[2]"}->{value};
}

1;
__END__