vcs.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 //Created by Mateusz Półrola
  23
  24 #ifndef COMPRESSEDREADER_H
  25 #define COMPRESSEDREADER_H
  26
  27 #include <QObject>
  28 #include <zconf.h>
  29 #include <zlibdefs.h>
  30 #include <zlib.h>
  31 #include "StarDictReader.h"
  32
  33 /*!
  34   Class implementing StarDictReader interface and handling rading from compressed
  35     files like .gz or .dz, using zlib
  36   */
  37 class CompressedReader : public StarDictReader
  38 {
  39     Q_OBJECT
  40 public:
  41     CompressedReader(QObject *parent = 0);
  42     /*!
  43       Creates new compressed reader and open file with passed filename
  44       */
  45     CompressedReader(QString filename, QObject *parent = 0);
  46     /*!
  47       Destructs object and closing file
  48     */
  49     ~CompressedReader();
  50
  51     /*!
  52       Reads translations text from compressed dict file.
  53       \param offset 32-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     QString readString(qint32 offset, qint32 len);
  58
  59     /*!
  60       Reads translations text from compressed dict file.
  61       \param offset 64-bit offset of translation in uncompressed file, readed
  62              from idx file
  63       \param len length of uncompressed translation, readed from idx file too
  64       */
  65     QString readString(qint64 offset, qint32 len);
  66
  67     /*!
  68       Reads 32-bits integer value from compressed file and convert it from
  69       BigEndian to Little Endian
  70       */
  71     qint32 readInt32BigEndian();
  72
  73     /*!
  74       Reads 64-bits integer value from compressed file and convert it from
  75       BigEndian to Little Endian
  76       */
  77     qint64 readInt64BigEndian();
  78
  79     /*!
  80       Reads single string from compressed file, end of string is marked as '\0'
  81      in file.
  82      */
  83     QString readKeyword();
  84
  85
  86     /*!
  87       Closing file;
  88       */
  89     void close();
  90
  91 protected:
  92     /*!
  93       Opens file
  94       \returns true if file is opened or false otherwise
  95       */
  96     bool open(QString file);
  97
  98     /*!
  99       Reads single char from compressed.
 100      */
 101     QChar readChar();
 102
 103 private:
 104     gzFile _file;
 105 };
 106
 107 #endif // COMPRESSEDREADER_H