=pod

=head1 LICENSE

Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
Copyright [2016-2022] EMBL-European Bioinformatics Institute

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

=cut


=head1 NAME

Bio::EnsEMBL::IO::Parser::GFF3Tabix - Parses tabix-indexed GFF3 files

=cut

=head1 DESCRIPTION

The tabix tool is available at the following address:
https://github.com/samtools/tabix

=cut

package Bio::EnsEMBL::IO::Parser::GFF3Tabix;

use strict;
use warnings;
use Bio::EnsEMBL::IO::TabixParser;
use Bio::EnsEMBL::IO::Parser::GFF3;
use Bio::DB::HTS::Tabix;

use parent qw/Bio::EnsEMBL::IO::TabixParser Bio::EnsEMBL::IO::Parser::GFF3/;

sub open {
  my ($caller, $filename, @other_args) = @_;
  my $class = ref($caller) || $caller;

  my $self = $class->SUPER::open($filename, @other_args);

  if($self->{'params'}->{'must_parse_metadata'}) {
    my $tabix_data = $self->{tabix_file}->header;
    foreach my $line (split("\n",$tabix_data || '')) {
      $self->{'current_block'} = $line;
      $self->Bio::EnsEMBL::IO::Parser::GFF3::read_metadata();
    }

    delete($self->{'current_block'});
  }

  return $self;
}


=head2 read_record
    Description: Splits the current block along predefined delimiters
    Returntype : Void
=cut

sub read_record {
  my $self = shift;
  $self->Bio::EnsEMBL::IO::Parser::GFF3::read_record(@_);
}

1;
