OpenMS  3.0.0
GzipInputStream.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>
39 
40 #include <xercesc/util/BinInputStream.hpp>
41 #include <xercesc/util/PlatformUtils.hpp>
42 
43 namespace OpenMS
44 {
45  class String;
46 
51  class OPENMS_DLLAPI GzipInputStream :
52  public xercesc::BinInputStream
53  {
54 public:
56  explicit GzipInputStream(const String& file_name);
57 
58  explicit GzipInputStream(const char* const file_name);
59 
61  ~GzipInputStream() override;
62 
64  bool getIsOpen() const;
65 
71  XMLFilePos curPos() const override;
72 
84  XMLSize_t readBytes(XMLByte* const to_fill, const XMLSize_t max_to_read) override;
85 
96  const XMLCh* getContentType() const override;
97 
98  GzipInputStream() = delete;
99  GzipInputStream(const GzipInputStream& stream) = delete;
100  GzipInputStream& operator=(const GzipInputStream& stream) = delete;
101 
102 private:
104  GzipIfstream* gzip_ = nullptr;
107  };
108 
109  inline XMLFilePos GzipInputStream::curPos() const
110  {
111  return file_current_index_;
112  }
113 
114  inline bool GzipInputStream::getIsOpen() const
115  {
116  return gzip_->isOpen();
117  }
118 
119 } // namespace OpenMS
120 
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::GzipInputStream::gzip_
GzipIfstream * gzip_
pointer to an compression stream
Definition: GzipInputStream.h:104
OpenMS::GzipInputStream::file_current_index_
XMLSize_t file_current_index_
current index of the actual file
Definition: GzipInputStream.h:106
OpenMS::GzipInputStream::getIsOpen
bool getIsOpen() const
returns true if file is open
Definition: GzipInputStream.h:114
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
GzipIfstream.h
OpenMS::GzipInputStream
Implements the BinInputStream class of the xerces-c library in order to read gzip compressed XML file...
Definition: GzipInputStream.h:51
OpenMS::GzipIfstream
Decompresses files which are compressed in the gzip format (*.gzip)
Definition: GzipIfstream.h:46
OpenMS::GzipIfstream::isOpen
bool isOpen() const
returns whether a file is open.
Definition: GzipIfstream.h:137
OpenMS::GzipInputStream::curPos
XMLFilePos curPos() const override
returns the current position in the file
Definition: GzipInputStream.h:109