vcs.maemo.org Git - mdictionary/blob - src/plugins/stardict/StarDictPlugin.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 /*! \file xdxfplugin.h
  24 */
  25 #ifndef STARDICTPLUGIN_H
  26 #define STARDICTPLUGIN_H
  27
  28
  29 #include <QObject>
  30 #include <QDialog>
  31 #include <QRegExp>
  32 #include <QTime>
  33 #include <QFile>
  34 //#include <QXmlStreamReader>
  35 #include <QtPlugin>
  36 #include <QHash>
  37 #include <QIcon>
  38 #include <QtEndian>
  39
  40 #include "../../include/CommonDictInterface.h"
  41 #include "../../include/settings.h"
  42 #include "StarDictDialog.h"
  43 #include "TranslationStarDict.h"
  44
  45 class TranslationXdxf;
  46
  47 class StarDictPlugin : public CommonDictInterface
  48 {
  49     Q_OBJECT
  50     Q_INTERFACES(CommonDictInterface)
  51 public:
  52     StarDictPlugin(QObject *parent=0);
  53
  54     ~StarDictPlugin();
  55
  56     //! \returns source language code iso 639-2
  57     QString langFrom() const;
  58
  59     //! \returns destination language code iso 639-2
  60     QString langTo() const;
  61
  62     //! \returns dictionary name (like "old English" or so)
  63     QString name() const;
  64
  65     //! \returns dictionary type (xdxf, google translate, etc)
  66     QString type() const;
  67
  68     //! returns information about dictionary in xml (name, authors, etc)
  69     QString infoNote() const;
  70
  71     /*! \returns DictDialog object that creates dialogs
  72         for adding a new dictionary and changing plugin settings
  73     */
  74     DictDialog* dictDialog();
  75
  76     //! \returns new, clean copy of plugin with settings set as in Settings*
  77     CommonDictInterface* getNew(const Settings*) const;
  78
  79     //! \returns whether plugin can start searching
  80     bool isAvailable() const;
  81
  82     //! \returns a description of a word given by a QString
  83     QString search(QString key) {
  84         return search(key, 0, 0);
  85     }
  86
  87     /*! \return a description of a word given by a QString
  88         \param offset offset of translation to be cut out
  89         \param len lenght of translation to be cut out
  90     */
  91     QString search(QString key, qint64 offset, qint32 len);
  92
  93     //! \returns current plugin settings
  94     Settings* settings();
  95
  96     //! \returns words count in a dictionary
  97     long wordsCount();
  98
  99     //! Sets new settings
 100     bool setSettings(const Settings*);
 101
 102     //! \returns plugin icon
 103     QIcon* icon();
 104
 105     /*! plugin should delete any files (eg. cache) that have been created and are ready
 106         to be deleted
 107     */
 108     void clean();
 109
 110
 111
 112 public Q_SLOTS:
 113     /*!
 114         performs search in a dictionary
 115         \param  word word to search for in a dictionary
 116         \param limit limit on number of results
 117
 118         After finishing search it has to emit
 119         \see CommonDictInterface:finalTranslation  finalTranslation
 120     */
 121     QList<Translation*> searchWordList(QString word, int limit=0);
 122
 123     //! stops current operation
 124     void stop();
 125
 126     //! loads translations for each plugin only once
 127     void retranslate();
 128
 129
 130 private:
 131
 132     /*!
 133         searches for a list of words similar to a word in a database file
 134         \param word key compared with keys in a database
 135         \param limit limits the number of translations in returned list,
 136         0 means unlimited
 137         \returns list of translations
 138     */
 139     QList<Translation*> searchWordListCache(QString word, int limit=0);
 140
 141     /*!
 142         searches for a list of words similar to a word in a xdxf file
 143         \param word key compared with keys in a xdxf file
 144         \param limit limits the number of translations in returned list,
 145         0 means unlimited
 146         \returns list of translations
 147     */
 148     QList<Translation*> searchWordListFile(QString word, int limit=0);
 149
 150     /*!
 151         searches for a translation of a word which is exactly like a key
 152         in a xdxf file
 153     */
 154     QString searchFile(QString key);
 155
 156     //! scans dictionary file to get information about it
 157     bool getDictionaryInfo();
 158
 159     //! counts the keys in a xdxf file
 160     int countWords();
 161
 162
 163     //! language from which we translate
 164     QString _langFrom;
 165     //! language to which we translate
 166     QString _langTo;
 167     //! name of a dictionary
 168     QString _name;
 169     //! information about dictionary
 170     QString _infoNote;
 171
 172     //! icon displayed during translations and when a dictionary is chosen
 173     QIcon _icon;
 174
 175     //! indicates if search is stopped
 176     volatile bool stopped;
 177     Settings *_settings;
 178     StarDictDialog* _dictDialog;
 179     Settings* _ifoFileSettings;
 180
 181     /*!
 182         Reads and process (converting to qstring) data from StarDict dictionary
 183         file (*.dict[.dz])
 184         \return converted translation
 185         \param QByteArray raw data to process
 186         \param mode StarDict parametr "sametypesequence"
 187     */
 188     QString format(QByteArray, QString mode,QString key);
 189
 190     /*!
 191         Reads bytes bytes of data or reads until \0
 192         \param it iterator to given data
 193         \param end end of data
 194         \param bytes to read
 195         \return readed data chunk
 196     */
 197     QByteArray read(QByteArray::iterator it, QByteArray::iterator end,
 198            int bytes = 0);
 199
 200     /*!
 201         Interpret data basis on mode (StarDict dict data type)
 202         \param it iterator on given data set
 203         \param end iterator pointing to the data end
 204         \param mode stardict dict data type
 205         \param last used to interpret sametypesequence field last letter (see
 206         StarDict format description)
 207         \return QSting containing interpreted data chunk
 208     */
 209     QString interpret(QByteArray::iterator it, QByteArray::iterator end,
 210             QChar mode,QString key, bool last = false);
 211
 212     friend class StarDictTests;
 213 };
 214
 215 #endif // XDXFPLUGIN_H
 216
 217