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,starDict 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     /*!
  88         \return a description of a word given by a QString
  89         \param offset offset of translation to be cut out
  90         \param len lenght of translation to be cut out
  91     */
  92     QString search(QString key, qint64 offset, qint32 len);
  93
  94     //! \returns current plugin settings
  95     Settings* settings();
  96
  97     //! \returns words count in a dictionary
  98     long wordsCount();
  99
 100     //! Sets new settings
 101     bool setSettings(const Settings*);
 102
 103     //! \returns plugin icon
 104     QIcon* icon();
 105
 106     /*!
 107         plugin should delete any files (eg. cache) that have been created and are ready
 108         to be deleted
 109     */
 110     void clean();
 111
 112
 113
 114 public Q_SLOTS:
 115     /*!
 116         performs search in a dictionary
 117         \param  word word to search for in a dictionary
 118         \param limit limit on number of results
 119
 120         After finishing search it has to emit
 121         \see CommonDictInterface:finalTranslation  finalTranslation
 122     */
 123     QList<Translation*> searchWordList(QString word, int limit=0);
 124
 125     //! stops current operation
 126     void stop();
 127
 128     //! loads translations for each plugin only once
 129     void retranslate();
 130
 131
 132 private:
 133
 134     /*!
 135         searches for a list of words similar to a word in file
 136         \param word key compared with keys in a file
 137         \param limit limits the number of translations in returned list,
 138         0 means unlimited
 139         \returns list of translations
 140     */
 141     QList<Translation*> searchWordListCache(QString word, int limit=0);
 142
 143     /*!
 144         searches for a list of words similar to a word in a starDict file
 145         \param word key compared with keys in a starDict file
 146         \param limit limits the number of translations in returned list,
 147         0 means unlimited
 148         \returns list of translations
 149     */
 150     QList<Translation*> searchWordListFile(QString word, int limit=0);
 151
 152     /*!
 153         searches for a translation of a word which is exactly like a key
 154         in a starDict file
 155     */
 156     QString searchFile(QString key);
 157
 158     //! scans dictionary file to get information about it
 159     bool getDictionaryInfo();
 160
 161     //! counts the keys in a starDict file
 162     int countWords();
 163
 164
 165     //! language from which we translate
 166     QString _langFrom;
 167     //! language to which we translate
 168     QString _langTo;
 169     //! name of a dictionary
 170     QString _name;
 171     //! information about dictionary
 172     QString _infoNote;
 173
 174     //! icon displayed during translations and when a dictionary is chosen
 175     QIcon _icon;
 176
 177     //! indicates if search is stopped
 178     volatile bool stopped;
 179     Settings *_settings;
 180     StarDictDialog* _dictDialog;
 181     Settings* _ifoFileSettings;
 182
 183     /*!
 184         Reads and process (converting to qstring) data from StarDict dictionary
 185         file (*.dict[.dz])
 186         \return converted translation
 187         \param QByteArray raw data to process
 188         \param mode StarDict parametr "sametypesequence"
 189     */
 190     QString format(QByteArray, QString mode,QString key);
 191
 192     /*!
 193         Reads bytes bytes of data or reads until \0
 194         \param it iterator to given data
 195         \param end end of data
 196         \param bytes to read
 197         \return readed data chunk
 198     */
 199     QByteArray read(QByteArray::iterator it, QByteArray::iterator end,
 200            int bytes = 0);
 201
 202     /*!
 203         Interpret data basis on mode (StarDict dict data type)
 204         \param it iterator on given data set
 205         \param end iterator pointing to the data end
 206         \param mode stardict dict data type
 207         \param last used to interpret sametypesequence field last letter (see
 208         StarDict format description)
 209         \return QSting containing interpreted data chunk
 210     */
 211     QString interpret(QByteArray::iterator it, QByteArray::iterator end,
 212             QChar mode,QString key, bool last = false);
 213
 214     friend class StarDictTests;
 215 };
 216
 217 #endif // XDXFPLUGIN_H
 218
 219