OpenMS  3.0.0
Bzip2Ifstream.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: David Wojnar $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h>
38 #include <bzlib.h>
39 #include <istream>
40 
41 namespace OpenMS
42 {
46  class OPENMS_DLLAPI Bzip2Ifstream
47  {
48 public:
50  Bzip2Ifstream();
52  explicit Bzip2Ifstream(const char * filename);
54  virtual ~Bzip2Ifstream();
55 
70  size_t read(char * s, size_t n);
71 
77  bool streamEnd() const;
78 
82  bool isOpen() const;
83 
88  void open(const char * filename);
89 
93  void close();
94 
95 protected:
97  FILE * file_;
99  BZFILE * bzip2file_;
101  size_t n_buffer_;
103  int bzerror_;
106 
107  //not implemented
108  Bzip2Ifstream(const Bzip2Ifstream & bzip2);
109  Bzip2Ifstream & operator=(const Bzip2Ifstream & bzip2);
110  };
111 
112  //return bzip2file???!!!!????
113  inline bool Bzip2Ifstream::isOpen() const
114  {
115  return file_ != nullptr;
116  }
117 
118  inline bool Bzip2Ifstream::streamEnd() const
119  {
120  return stream_at_end_;
121  }
122 
123 } //namespace OpenMS
OpenMS::Bzip2Ifstream::isOpen
bool isOpen() const
returns whether a file is open.
Definition: Bzip2Ifstream.h:113
OpenMS::Bzip2Ifstream::bzip2file_
BZFILE * bzip2file_
a pointer to a BZFILE object. Necessary for decompression
Definition: Bzip2Ifstream.h:99
OpenMS::Bzip2Ifstream::streamEnd
bool streamEnd() const
indicates whether the read function can be used safely
Definition: Bzip2Ifstream.h:118
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Bzip2Ifstream::bzerror_
int bzerror_
saves the last returned error by the read function
Definition: Bzip2Ifstream.h:103
OpenMS::Bzip2Ifstream::n_buffer_
size_t n_buffer_
counts the last read buffer
Definition: Bzip2Ifstream.h:101
OpenMS::Bzip2Ifstream
Decompresses files which are compressed in the bzip2 format (*.bz2)
Definition: Bzip2Ifstream.h:46
OpenMS::Bzip2Ifstream::file_
FILE * file_
pointer to a FILE object. Necessary for opening the file
Definition: Bzip2Ifstream.h:97
OpenMS::Bzip2Ifstream::stream_at_end_
bool stream_at_end_
true if end of file is reached
Definition: Bzip2Ifstream.h:105