vcs.maemo.org Git - mdictionary/blob - src/plugins/xdxf/xdxfplugin.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 XDXFPLUGIN_H
  26 #define XDXFPLUGIN_H
  27
  28
  29 #include <QObject>
  30 #include <QDialog>
  31 #include <QRegExp>
  32 #include <QTime>
  33 #include <QSqlQuery>
  34 #include <QSqlDatabase>
  35 #include <QSqlError>
  36 #include <QFile>
  37 #include <QXmlStreamReader>
  38 #include <QtPlugin>
  39 #include <QHash>
  40
  41 #include "../../include/CommonDictInterface.h"
  42 #include "../../include/settings.h"
  43 #include "XdxfDictDialog.h"
  44 #include "XdxfCachingDialog.h"
  45 #include "TranslationXdxf.h"
  46 #include "XdxfDictDownloader.h"
  47
  48 class TranslationXdxf;
  49
  50 class XdxfPlugin : public CommonDictInterface
  51 {
  52     Q_OBJECT
  53     Q_INTERFACES(CommonDictInterface)
  54 public:
  55     XdxfPlugin(QObject *parent=0);
  56
  57     ~XdxfPlugin();
  58
  59     //! \returns source language code iso 639-2
  60     QString langFrom() const;
  61
  62     //! \returns destination language code iso 639-2
  63     QString langTo() const;
  64
  65     //! \returns dictionary name (like "old English" or so)
  66     QString name() const;
  67
  68     //! \returns dictionary type (xdxf, google translate, etc)
  69     QString type() const;
  70
  71     //! returns information about dictionary in xml (name, authors, etc)
  72     QString infoNote() const;
  73
  74     /*! \returns DictDialog object that creates dialogs
  75         for adding a new dictionary and changing plugin settings
  76       */
  77     DictDialog* dictDialog();
  78
  79     //! \returns new, clean copy of plugin with settings set as in Settings*
  80     CommonDictInterface* getNew(const Settings*) const;
  81
  82     //! \returns whether plugin can start searching
  83     bool isAvailable() const;
  84
  85     //! \returns a description of a word given by a QString
  86     QString search(QString key);
  87
  88     //! \returns current plugin settings
  89     Settings* settings();
  90
  91     //! \returns words count in a dictionary
  92     long wordsCount();
  93
  94     //! Sets new settings
  95     bool setSettings(const Settings*);
  96
  97     //! \returns plugin icon
  98     QIcon* icon();
  99
 100     /*! plugin should delete any files (eg. cache) that have been created and are ready
 101         to be deleted
 102         */
 103     void clean();
 104
 105     static XdxfDictDownloader dictDownloader;
 106
 107 public Q_SLOTS:
 108     /*! performs search in a dictionary
 109       \param  word word to search for in a dictionary
 110       \param limit limit on number of results
 111
 112       After finishing search it has to emit
 113       \see CommonDictInterface:finalTranslation  finalTranslation
 114     */
 115     QList<Translation*> searchWordList(QString word, int limit=0);
 116
 117     //! stops current operation
 118     void stop();
 119
 120     //! loads translations for each plugin only once
 121     void retranslate();
 122
 123 Q_SIGNALS:
 124     //! emitted with percent count of caching progress, and time elapsed from
 125     //! last signal emit
 126     void updateCachingProgress(int, int);
 127
 128
 129 private:
 130
 131     /*! \returns true or false depending on whether the dictionary is cached
 132         or not
 133      */
 134     bool isCached();
 135     /*! searches for a list of words similar to a word in a database file
 136     \param word key compared with keys in a database
 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     /*! searches for a list of words similar to a word in a xdxf file
 144     \param word key compared with keys in a xdxf file
 145     \param limit limits the number of translations in returned list,
 146            0 means unlimited
 147     \returns list of translations
 148     */
 149     QList<Translation*> searchWordListFile(QString word, int limit=0);
 150
 151     /*! searches for a translation of a word which is exactly like a key
 152         in a xdxf file */
 153     QString searchFile(QString key);
 154
 155     /*! searches for a translation of a word which is exactly like a key
 156         in a database file */
 157     QString searchCache(QString key);
 158
 159     //! scans dictionary file to get information about it
 160     bool getDictionaryInfo();
 161
 162     //! counts the keys in a xdxf file
 163     int countWords();
 164
 165     /*! transforms xdxf files to database files (caching operation)
 166         \returns true on success, false on failure */
 167     bool makeCache(QString dir);
 168
 169     //! language from which we translate
 170     QString _langFrom;
 171     //! language to which we translate
 172     QString _langTo;
 173     //! name of a dictionary
 174     QString _name;
 175     //! information about dictionary
 176     QString _infoNote;
 177
 178     QString _dictionaryInfo;
 179
 180     //! icon displayed during translations and when a dictionary is chosen
 181     QIcon _icon;
 182     QSqlDatabase db;
 183     QString db_name;
 184     //! number of words in a dictionary
 185     long _wordsCount;
 186     //! indicates if search is stopped
 187     volatile bool stopped;
 188     Settings *_settings;
 189     XdxfDictDialog* _dictDialog;
 190     XdxfCachingDialog* cachingDialog;
 191 };
 192
 193 #endif // XDXFPLUGIN_H
 194
 195