vcs.maemo.org Git - mdictionary/blob - src/plugins/stardict/UncompressedReader.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 UncompressedReader.h
  23     \brief Class implementing StarDictReader interface and handling
  24   reading from uncompressed files
  25
  26     \author Mateusz Półrola <mateusz.polrola@comarch.pl>
  27  */
  28
  29 #ifndef UNCOMPRESSEDREADER_H
  30 #define UNCOMPRESSEDREADER_H
  31
  32 #include <QObject>
  33 #include <QFile>
  34 #include <QDataStream>
  35 #include <QString>
  36 #include "StarDictReader.h"
  37
  38
  39 /*!
  40   Class implementing StarDictReader interface and handling
  41   reading from uncompressed files
  42 */
  43 class UncompressedReader : public StarDictReader
  44 {
  45     Q_OBJECT
  46 public:
  47     UncompressedReader(QObject *parent = 0);
  48
  49     //! Creates new reader and open file with passed filename
  50     UncompressedReader(QString filename, QObject *parent = 0);
  51
  52     //! Destructs object and closing file
  53     ~UncompressedReader();
  54
  55     /*!
  56         Reads translations text from file
  57         \param offset 64-bit offset of translation in file, readed
  58         from idx file
  59         \param len length of translation, readed from idx file too
  60     */
  61     QByteArray readString(qint64 offset, qint32 len);
  62
  63     /*!
  64         Reads 32-bits integer value from file and convert it from
  65         BigEndian to Little Endian
  66     */
  67     qint32 readInt32BigEndian();
  68
  69     /*!
  70         Reads 64-bits integer value from file and convert it from
  71         BigEndian to Little Endian
  72     */
  73     qint64 readInt64BigEndian();
  74
  75     /*!
  76         Reads single string from file, end of string is marked as '\0'
  77         in file.
  78     */
  79     QString readKeyword();
  80
  81     //! Closing file;
  82     void close();
  83
  84 protected:
  85     /*!
  86         Opens file
  87         \returns true if file is opened or false otherwise
  88     */
  89     bool open(QString file);
  90
  91     //! Reads single char from compressed.
  92     QChar readChar();
  93
  94 private:
  95     QFile _file;
  96     QDataStream _stream;
  97 };
  98
  99 #endif // UNCOMPRESSEDREADER_H