vcs.maemo.org Git - mdictionary/blob - src/plugins/stardict/StarDictReader.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 StarDictReader.h
  23     \brief Abstract class used for reading stardict dict and idx files.
  24
  25     \author Mateusz Półrola <mateusz.polrola@comarch.pl>
  26  */
  27
  28 #ifndef STARDICTREADER_H
  29 #define STARDICTREADER_H
  30
  31 #include <QObject>
  32
  33 /*!
  34     Abstract class used for reading stardict dict and idx files.
  35     It allows to read all necessary data types used in parsing stardict files.
  36 */
  37 class StarDictReader : public QObject {
  38     Q_OBJECT
  39 public:
  40     StarDictReader(QObject *parent = 0) : QObject(parent) {}
  41     virtual ~StarDictReader() {}
  42
  43     /*!
  44         Reads translations text from dict file.
  45         \param offset 64-bit offset of translation in file, readed from idx file
  46         \param len length of translation, readed from idx file too
  47     */
  48     virtual QByteArray readString(qint64 offset, qint32 len)=0;
  49
  50     /*!
  51         Reads 32-bits integer value from file and convert it from BigEndian
  52         to Little Endian
  53     */
  54     virtual qint32 readInt32BigEndian()=0;
  55
  56     /*!
  57         Reads 64-bits integer value from file and convert it from BigEndian
  58         to Little Endian
  59     */
  60     virtual qint64 readInt64BigEndian()=0;
  61
  62     //! Reads single string from file, end of string is marked as '\0' in file.
  63     virtual QString readKeyword()=0;
  64
  65
  66     //! Closing file;
  67     virtual void close()=0;
  68
  69 protected:
  70     /*!
  71         Opens file
  72         \returns true if file is opened or false otherwise
  73     */
  74     virtual bool open(QString file)=0;
  75
  76     //! Reads single char from file.
  77     virtual QChar readChar()=0;
  78
  79 };
  80
  81 #endif // STARDICTREADER_H