git.maemo.org Git - mdictionary/blob - src/plugins/stardict/CompressedReader.h

   1 /*******************************************************************************
   2
   3     This file is part of mDictionary.
   4
   5     mDictionary is free software: you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation, either version 3 of the License, or
   8     (at your option) any later version.
   9
  10     mDictionary is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with mDictionary.  If not, see <http://www.gnu.org/licenses/>.
  17
  18     Copyright 2010 Comarch S.A.
  19
  20 *******************************************************************************/
  21 /*!
  22     \file CompressedReader.cpp
  23     \author Mateusz Półrola
  24 */
  25
  26 #ifndef COMPRESSEDREADER_H
  27 #define COMPRESSEDREADER_H
  28
  29 #include <QObject>
  30 #include <zconf.h>
  31 //#include <zlibdefs.h>
  32 #include <zlib.h>
  33 #include "StarDictReader.h"
  34
  35 /*!
  36     Class implementing StarDictReader interface and handling rading from compressed
  37     files like .gz or .dz, using zlib
  38 */
  39 class CompressedReader : public StarDictReader
  40 {
  41     Q_OBJECT
  42 public:
  43     CompressedReader(QObject *parent = 0);
  44
  45     //! Creates new compressed reader and open file with passed filename
  46     CompressedReader(QString filename, QObject *parent = 0);
  47
  48     //! Destructs object and closing file
  49     ~CompressedReader();
  50
  51     /*!
  52         Reads translations text from compressed dict file.
  53         \param offset 64-bit offset of translation in uncompressed file, readed
  54              from idx file
  55         \param len length of uncompressed translation, readed from idx file too
  56     */
  57     QByteArray readString(qint64 offset, qint32 len);
  58
  59     /*!
  60         Reads 32-bits integer value from compressed file and convert it from
  61         BigEndian to Little Endian
  62     */
  63     qint32 readInt32BigEndian();
  64
  65     /*!
  66         Reads 64-bits integer value from compressed file and convert it from
  67         BigEndian to Little Endian
  68     */
  69     qint64 readInt64BigEndian();
  70
  71     /*!
  72         Reads single string from compressed file, end of string is marked as '\0'
  73         in file.
  74     */
  75     QString readKeyword();
  76
  77
  78     //! Closing file;
  79     void close();
  80
  81 protected:
  82     /*!
  83         Opens file
  84         \returns true if file is opened or false otherwise
  85     */
  86     bool open(QString file);
  87
  88     //! Reads single char from compressed.
  89     QChar readChar();
  90
  91 private:
  92     gzFile _file;
  93 };
  94
  95 #endif // COMPRESSEDREADER_H