init

[qstardict] / qstardict / dictcore.h

diff --git a/qstardict/dictcore.h b/qstardict/dictcore.h
new file mode 100644 (file)
index 0000000..c90cd50
--- /dev/null
+++ b/qstardict/dictcore.h
@@ -0,0 +1,171 @@
+/*****************************************************************************
+ * dictcore.h - QStarDict, a StarDict clone written with using Qt            *
+ * Copyright (C) 2007 Alexander Rodin                                        *
+ *                                                                           *
+ * This program is free software; you can redistribute it and/or modify      *
+ * it under the terms of the GNU General Public License as published by      *
+ * the Free Software Foundation; either version 2 of the License, or         *
+ * (at your option) any later version.                                       *
+ *                                                                           *
+ * This program is distributed in the hope that it will be useful,           *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
+ * GNU General Public License for more details.                              *
+ *                                                                           *
+ * You should have received a copy of the GNU General Public License along   *
+ * with this program; if not, write to the Free Software Foundation, Inc.,   *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.               *
+ *****************************************************************************/
+
+#ifndef DICTCORE_H
+#define DICTCORE_H
+
+#include <QObject>
+
+#include <QStringList>
+#include <QPair>
+#include <QHash>
+#include <QPluginLoader>
+
+#include "../plugins/dictplugin.h"
+
+
+namespace QStarDict
+{
+
+/**
+ * The DictCore is a base dictionary class.
+ */
+class DictCore: public QObject
+{
+    Q_OBJECT
+
+    public:
+        /**
+         * This class represents a dictionary.
+         */
+        class Dictionary
+        {
+            public:
+                Dictionary(const QString &plugin, const QString &name)
+                    : m_plugin(plugin),
+                      m_name(name)
+                {  }
+                Dictionary()
+                { }
+                
+                const QString &plugin() const
+                { return m_plugin; }
+                const QString &name() const
+                { return m_name; }
+                void setPlugin(const QString &plugin)
+                { m_plugin = plugin; }
+                void setName(const QString &name)
+                { m_name = name; }
+                bool operator == (const Dictionary &dict)
+                { return m_name == dict.m_name && m_plugin == dict.m_plugin; }
+
+            private:
+                QString m_plugin;
+                QString m_name;
+        };
+
+        /**
+         * Construct dictionary.
+         */
+        DictCore(QObject *parent = 0);
+        /**
+         * Destructor.
+         */
+        ~DictCore();
+
+        /**
+         * Returns true if word is exists in dictionaries,
+         * otherwise false.
+         */
+        bool isTranslatable(const QString &word);
+        /**
+         * Returns translation for word. If word not found, returns
+         * "Not found!"
+         */
+        QString translate(const QString &word);
+        /**
+         * Returns a list of similar words contained in dictionaries.
+         */
+        QStringList findSimilarWords(const QString &word);
+
+        /**
+         * Returns a list of available dictionary plugins.
+         */
+        QStringList availablePlugins() const;
+
+        /**
+         * Returns a list of loaded dictionary plugins.
+         */
+        QStringList loadedPlugins() const
+        { return QStringList(m_plugins.keys()); }
+
+        /**
+         * Sets a loaded plugins.
+         * If plugin cannot be loaded it will not be added to
+         * loadedPlugins list.
+         */
+        void setLoadedPlugins(const QStringList &loadedPlugins);
+
+        /**
+         * Returns a list of available dictionaries.
+         * The first item in pair is a plugin name, the second item
+         * in pair is a dictionary name.
+         */
+        QList<Dictionary> availableDicts() const;
+
+        /**
+         * Returns a list of loaded dictionaries. 
+         * The first item in pair is a plugin name, the second item
+         * in pair is a dictionary name.
+         */
+        const QList<Dictionary> &loadedDicts() const
+        { return m_loadedDicts; }
+
+        /**
+         * Sets a loaded dictionaries.
+         * The first item in pair is a plugin name, the second item
+         * in pair is a dictionary name.
+         * If dictionary cannot be loaded it will not be added to 
+         * availableDicts list.
+         */
+        void setLoadedDicts(const QList<Dictionary> &loadedDicts);
+
+        /**
+         * Reload loaded dicts.
+         */
+        void reloadDicts();
+
+        /**
+         * Returns pointer to plugin instance or 0 if not loaded.
+         */
+        DictPlugin *plugin(const QString &plugin)
+        { return m_plugins.contains(plugin) ? qobject_cast<DictPlugin*>(m_plugins[plugin]->instance()) : 0; }
+
+        /**
+         * Save settings.
+         */
+        void saveSettings();
+
+    private:
+
+        /**
+         * Load settings.
+         */
+        void loadSettings();
+
+        QHash<QString, QPluginLoader*> m_plugins;
+        QList<Dictionary> m_loadedDicts;
+};
+
+}
+
+#endif // DICTCORE_H
+
+// vim: tabstop=4 softtabstop=4 shiftwidth=4 expandtab cindent textwidth=120 formatoptions=tc
+