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