Bzip2Ifstream.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: David Wojnar $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
#include <cstddef>  // for size_t
#include <cstdio>   // for std::FILE (used to come in through <bzlib.h>)
#include <istream>
 
// <bzlib.h> is deliberately not included here: bzip2 is a PRIVATE dependency of
// libOpenMS, so no installed header may require its include directory. The only
// bzip2 type this class needs is BZFILE, which bzlib defines as `typedef void
// BZFILE;`, so the handle is stored as a void* below. Bzip2Ifstream.cpp includes
// <bzlib.h> and does the conversions.
 
namespace OpenMS
{
  class OPENMS_DLLAPI Bzip2Ifstream
  {
public:
    Bzip2Ifstream();
 
    explicit Bzip2Ifstream(const char * filename);
 
    virtual ~Bzip2Ifstream();
 
    size_t read(char * s, size_t n);
 
    bool streamEnd() const;
 
    bool isOpen() const;
 
    void open(const char * filename);
 
    void close();
 
protected:
    std::FILE * file_;
    void * bzip2file_;
    size_t     n_buffer_;
    int     bzerror_;
    bool stream_at_end_;
 
    //not implemented
    Bzip2Ifstream(const Bzip2Ifstream & bzip2);
    Bzip2Ifstream & operator=(const Bzip2Ifstream & bzip2);
  };
 
  //return bzip2file???!!!!????
  inline bool Bzip2Ifstream::isOpen() const
  {
    return file_ != nullptr;
  }
 
  inline bool Bzip2Ifstream::streamEnd() const
  {
    return stream_at_end_;
  }
 
} //namespace OpenMS