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