GzipIfstream.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 (used to come in through <zlib.h>)
 
// <zlib.h> is deliberately not included here: zlib is a PRIVATE dependency of
// libOpenMS, so no installed header may require its include directory. The only
// zlib type this class needs is gzFile, which both zlib and zlib-ng's drop-in
// compatibility header declare as `typedef struct gzFile_s *gzFile;`, so a
// forward declaration of that opaque struct is enough. GzipIfstream.cpp includes
// <zlib.h> and calls the API.
struct gzFile_s;
 
namespace OpenMS
{
  class OPENMS_DLLAPI GzipIfstream
  {
public:
    GzipIfstream();
 
    explicit GzipIfstream(const char * filename);
 
    virtual ~GzipIfstream();
 
    size_t read(char * s, size_t n);
 
    bool streamEnd() const;
 
    bool isOpen() const;
 
    void open(const char * filename);
 
    void close();
 
    /*
        @brief updates crc32 check sum whether the buffer is corrupted
        @note if this function is used it has to be called after every call of function read
        @param[in] s the buffer which will be checked
        @param[in] n the size of the buffer
    *
    //void updateCRC32(const char* s,const size_t n);
 
    *
        @brief  checks if data is corrupted after crc32 was computed
        @note   it can only be used if updateCRC32 was called after every call of function read
        @return true if the buffer and hence the file is corrupted; no decompression is possible
    *
    //bool isCorrupted();
 
    //unsigned long Crc32_ComputeBuf( unsigned long inCrc32, const void *buf,
//                                 size_t bufLen );*/
 
protected:
 
    gzFile_s * gzfile_;
    int n_buffer_;
    int gzerror_;
    bool stream_at_end_;
 
    //needed if one wants to know whether file is okay
    //unsigned long original_crc;
    //needed if one wants to know whether file is okay
    //unsigned long crc;
 
    GzipIfstream(const GzipIfstream & bzip2);
    GzipIfstream & operator=(const GzipIfstream & bzip2);
  };
 
  inline bool GzipIfstream::isOpen() const
  {
    return gzfile_ != nullptr;
  }
 
  inline bool GzipIfstream::streamEnd() const
  {
    return stream_at_end_;
  }
 
/*  inline bool GzipIfstream::isCorrupted()
    {
        std::cout<<"CRC"<<crc<<std::endl;
        return (crc != original_crc);
    }*/
 
} //namespace OpenMS