Fix #24. Add spell checking support using Enchant library (wrapper for Aspell, Hunspell, and others).

Thanks to alexzulu and S658P for inspiration, and to Pragma for code review.


git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@6416 17fca916-40b9-46aa-a4ea-0a15b648b75c

2 files changed, 165 insertions, 0 deletions

diff --git a/src/modules/spellchecker/CMakeLists.txt b/src/modules/spellchecker/CMakeLists.txt
new file mode 100644
index 000000000..34b241e0e
--- /dev/null
+++ b/src/modules/spellchecker/CMakeLists.txt
@@ -0,0 +1,8 @@
+# CMakeLists for src/modules/avatar
+
+set(kvispellchecker_SRCS
+	libkvispellchecker.cpp
+)
+
+set(kvi_module_name kvispellchecker)
+include(${CMAKE_SOURCE_DIR}/cmake/module.rules.txt)
diff --git a/src/modules/spellchecker/libkvispellchecker.cpp b/src/modules/spellchecker/libkvispellchecker.cpp
new file mode 100644
index 000000000..0a384d77a
--- /dev/null
+++ b/src/modules/spellchecker/libkvispellchecker.cpp
@@ -0,0 +1,157 @@
+//=============================================================================
+//
+//   File : libkvispellchecker.cpp
+//   Creation date : Thu Dec 26 2014 15:12:12 GMT by Alexey Sokolov
+//
+//   This file is part of the KVIrc IRC client distribution
+//   Copyright © 2014 Alexey Sokolov <sokolov@google.com>
+//
+//   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 opinion) 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.
+//
+//=============================================================================
+
+#include "KviModule.h"
+#include "KviOptions.h"
+#include <enchant.h>
+
+static EnchantBroker* g_pEnchantBroker = NULL;
+static KviPointerList<EnchantDict>* g_pEnchantDicts = NULL;
+
+/*
+	@doc: spellchecker.available_dictionaries
+	@type:
+		function
+	@title:
+		$spellchecker.available_dictionaries
+	@short:
+		Return available dictionaries.
+	@syntax:
+		<hash> $spellchecker.available_dictionaries
+	@description:
+		This function returns a hash. For every supported dictionary, key is the language code,
+		value is name of provider for that language (e.g. Aspell).
+*/
+static void spellchecker_enumerate_dicts(const char* szLang, const char* /*szName*/,
+		const char* szDesc, const char* /*szFile*/, void* pData) {
+	KviKvsHash* pHash = reinterpret_cast<KviKvsHash*>(pData);
+	pHash->set(szLang, new KviKvsVariant(szDesc));
+}
+static bool spellchecker_kvs_available_dictionaries(KviKvsModuleFunctionCall* c) {
+	KVSM_PARAMETERS_BEGIN(c)
+	KVSM_PARAMETERS_END(c)
+	KviKvsHash* pHash = new KviKvsHash;
+	enchant_broker_list_dicts(g_pEnchantBroker, spellchecker_enumerate_dicts, pHash);
+	c->returnValue()->setHash(pHash);
+	return true;
+}
+
+/*
+	@doc: spellchecker.check
+	@type:
+		function
+	@title:
+		$spellchecker.check
+	@short:
+		Check a single work for spelling mistakes.
+	@syntax:
+		<bool> $spellchecker.check(<word:string>)
+	@description:
+		This function returns true if the word is spelled correctly.
+*/
+static bool spellchecker_kvs_check(KviKvsModuleFunctionCall* c) {
+	QString szWord;
+	KVSM_PARAMETERS_BEGIN(c)
+		KVSM_PARAMETER("word", KVS_PT_STRING, 0, szWord)
+	KVSM_PARAMETERS_END(c)
+	QByteArray utf8 = szWord.toUtf8();
+	bool bResult = g_pEnchantDicts->isEmpty();
+	KviPointerListIterator<EnchantDict> it(*g_pEnchantDicts);
+	for (bool b = it.moveFirst(); b; b = it.moveNext()) {
+		bResult |= enchant_dict_check(*it, utf8.data(), utf8.size()) == 0;
+	}
+	c->returnValue()->setBoolean(bResult);
+	return true;
+}
+
+static void spellchecker_reload_dicts() {
+	while (!g_pEnchantDicts->isEmpty()) {
+		enchant_broker_free_dict(g_pEnchantBroker, g_pEnchantDicts->takeFirst());
+	}
+	const QStringList& wantedDictionaries = KVI_OPTION_STRINGLIST(KviOption_stringlistSpellCheckerDictionaries);
+	foreach(QString szLang, wantedDictionaries) {
+		EnchantDict* pDict = enchant_broker_request_dict(g_pEnchantBroker, szLang.toUtf8().data());
+		if (pDict) {
+			g_pEnchantDicts->append(pDict);
+		} else {
+			qDebug("Can't load spellchecker dictionary %s: %s", szLang.toUtf8().data(), enchant_broker_get_error(g_pEnchantBroker));
+		}
+	}
+}
+
+/*
+	@doc: spellchecker.reloadDictionaries
+	@type:
+		command
+	@title:
+		spellchecker.reloadDictionaries
+	@short:
+		Reload spell checker dictionaries
+	@syntax:
+		spellchecker.reloadDictionaries
+	@description:
+		Reload spell checker dictionaries
+*/
+static bool spellchecker_kvs_reload_dictionaries(KviKvsModuleCommandCall * c)
+{
+	KVSM_PARAMETERS_BEGIN(c)
+	KVSM_PARAMETERS_END(c)
+	spellchecker_reload_dicts();
+	return true;
+}
+
+static bool spellchecker_module_init(KviModule* m) {
+	g_pEnchantBroker = enchant_broker_init();
+	g_pEnchantDicts = new KviPointerList<EnchantDict>(/* bAutoDelete = */ false);
+
+	spellchecker_reload_dicts();
+
+	KVSM_REGISTER_SIMPLE_COMMAND(m, "reloadDictionaries", spellchecker_kvs_reload_dictionaries);
+	KVSM_REGISTER_FUNCTION(m, "availableDictionaries", spellchecker_kvs_available_dictionaries);
+	KVSM_REGISTER_FUNCTION(m, "check", spellchecker_kvs_check);
+	return true;
+}
+
+static bool spellchecker_module_cleanup(KviModule*) {
+	while (!g_pEnchantDicts->isEmpty()) {
+		enchant_broker_free_dict(g_pEnchantBroker, g_pEnchantDicts->takeFirst());
+	}
+	delete g_pEnchantDicts;
+	g_pEnchantDicts = NULL;
+	enchant_broker_free(g_pEnchantBroker);
+	g_pEnchantBroker = NULL;
+	return true;
+}
+
+KVIRC_MODULE(
+	"SpellChecker", // module name
+	"4.0.0", // module version
+	"Copyright (C) 2014 Alexey Sokolov (sokolov at google dot com)", // author & (C)
+	"Spell checker",
+	spellchecker_module_init,
+	0,
+	0,
+	spellchecker_module_cleanup,
+	0
+)