#include <config.h>
#include "AspellChecker.h"
+#include "PersonalWordList.h"
+
#include "LyXRC.h"
#include "WordLangTuple.h"
#include "support/debug.h"
#include "support/docstring_list.h"
+#include "support/filetools.h"
#include "support/Package.h"
#include "support/FileName.h"
#include "support/Path.h"
#include <map>
#include <string>
-#ifdef __APPLE__
-
-# ifndef ASPELL_FRAMEWORK
-# define ASPELL_FRAMEWORK "Aspell.framework"
-# endif
-# ifndef ASPELL_FRAMEWORK_DATA
-# define ASPELL_FRAMEWORK_DATA "/Resources/data"
-# endif
-# ifndef ASPELL_FRAMEWORK_DICT
-# define ASPELL_FRAMEWORK_DICT "/Resources/dict"
-# endif
-
-# ifndef ASPELL_MACPORTS
-# define ASPELL_MACPORTS "/opt/local"
-# endif
-# ifndef ASPELL_MACPORTS_DATA
-# define ASPELL_MACPORTS_DATA "/lib/aspell-0.60"
-# endif
-# ifndef ASPELL_MACPORTS_DICT
-# define ASPELL_MACPORTS_DICT "/share/aspell"
-# endif
-
-#endif /* __APPLE__ */
-
using namespace std;
using namespace lyx::support;
namespace {
struct Speller {
- ///AspellSpeller * speller;
AspellConfig * config;
AspellCanHaveError * e_speller;
+ docstring_list ignored_words_;
};
typedef std::map<std::string, Speller> Spellers;
+typedef map<std::string, PersonalWordList *> LangPersonalWordList;
} // anon namespace
~Private();
/// add a speller of the given language and variety
- AspellSpeller * addSpeller(string const & lang,
- string const & variety = string());
+ AspellSpeller * addSpeller(Language const * lang);
///
- AspellSpeller * speller(string const & lang,
- string const & variety);
+ AspellSpeller * speller(Language const * lang);
+
+ bool isValidDictionary(AspellConfig * config,
+ string const & lang, string const & variety);
+ bool checkAspellData(AspellConfig * config,
+ string const & basepath, string const & datapath, string const & dictpath,
+ string const & lang, string const & variety);
+ AspellConfig * getConfig(string const & lang, string const & variety);
+
+ SpellChecker::Result check(AspellSpeller * m,
+ string const & word) const;
- /// create a unique ID from lang code and variety
- string const spellerID(string const & lang,
- string const & variety);
+ void initSessionDictionary(Speller const & speller, PersonalWordList * pd);
+ void insert(WordLangTuple const & word);
+ void remove(WordLangTuple const & word);
+ bool learned(WordLangTuple const & word);
+
+ void accept(Speller & speller, WordLangTuple const & word);
/// the spellers
Spellers spellers_;
+ LangPersonalWordList personal_;
+
+ /// the location below system/user directory
+ /// there the rws files lookup will happen
+ const string dictDirectory(void) { return "dicts"; }
+ /// there the dat+cmap files lookup will happen
+ const string dataDirectory(void) { return "data"; }
+ /// os package directory constants
+ /// macports on Mac OS X or
+ /// aspell rpms on Linux
+ const string osPackageBase(void) {
+#ifdef USE_MACOSX_PACKAGING
+ return "/opt/local";
+#else
+ return "/usr";
+#endif
+ }
+ const string osPackageDictDirectory(void) {
+#ifdef USE_MACOSX_PACKAGING
+ return "/share/aspell";
+#else
+ return "/lib/aspell-0.60";
+#endif
+ }
+ const string osPackageDataDirectory(void) { return "/lib/aspell-0.60"; }
+
};
}
delete_aspell_config(it->second.config);
}
+
+ LangPersonalWordList::const_iterator pdit = personal_.begin();
+ LangPersonalWordList::const_iterator pdet = personal_.end();
+
+ for (; pdit != pdet; ++pdit) {
+ if ( 0 == pdit->second)
+ continue;
+ PersonalWordList * pd = pdit->second;
+ pd->save();
+ delete pd;
+ }
}
-bool isValidDictionary(AspellConfig * config,
+bool AspellChecker::Private::isValidDictionary(AspellConfig * config,
string const & lang, string const & variety)
{
bool have = false;
}
-bool checkAspellData(AspellConfig * config,
- char const * basepath, char const * datapath, char const * dictpath,
+bool AspellChecker::Private::checkAspellData(AspellConfig * config,
+ string const & basepath, string const & datapath, string const & dictpath,
string const & lang, string const & variety)
{
- bool have_dict = false;
FileName base(basepath);
- FileName data(base.absFileName() + datapath);
- FileName dict(base.absFileName() + dictpath);
- have_dict = dict.isDirectory() && data.isDirectory();
+ bool have_dict = base.isDirectory() ;
+
if (have_dict) {
- aspell_config_replace(config, "dict-dir", dict.absFileName().c_str());
- aspell_config_replace(config, "data-dir", data.absFileName().c_str());
- LYXERR(Debug::FILES, "aspell dict: " << dict);
- have_dict = isValidDictionary(config, lang, variety);
+ FileName data(addPath(base.absFileName(), datapath));
+ FileName dict(addPath(base.absFileName(), dictpath));
+ have_dict = dict.isDirectory() && data.isDirectory();
+ if (have_dict) {
+ LYXERR(Debug::FILES, "aspell dict-dir: " << dict);
+ LYXERR(Debug::FILES, "aspell data-dir: " << data);
+ aspell_config_replace(config, "dict-dir", dict.absFileName().c_str());
+ aspell_config_replace(config, "data-dir", data.absFileName().c_str());
+ have_dict = isValidDictionary(config, lang, variety);
+ }
}
return have_dict ;
}
-AspellConfig * getConfig(string const & lang,
- string const & variety)
+AspellConfig * AspellChecker::Private::getConfig(string const & lang, string const & variety)
{
AspellConfig * config = new_aspell_config();
-#ifdef __APPLE__
- char buf[2048] ;
bool have_dict = false;
- char const * sysdir = lyx::support::package().system_support().absFileName().c_str() ;
- char const * userdir = lyx::support::package().user_support().absFileName().c_str() ;
- char const * framework = ASPELL_FRAMEWORK ;
+ string const sysdir = lyx::support::package().system_support().absFileName() ;
+ string const userdir = lyx::support::package().user_support().absFileName() ;
- LYXERR(Debug::FILES, "aspell sysdir dir: " << sysdir);
LYXERR(Debug::FILES, "aspell user dir: " << userdir);
- have_dict = checkAspellData(config, userdir, ASPELL_FRAMEWORK_DATA, ASPELL_FRAMEWORK_DICT, lang, variety);
- if (!have_dict && strlen(framework) && getPrivateFrameworkPathName(buf, sizeof(buf), framework)) {
- LYXERR(Debug::FILES, "aspell bundle path: " << buf);
- have_dict = checkAspellData(config, buf, ASPELL_FRAMEWORK_DATA, ASPELL_FRAMEWORK_DICT, lang, variety);
+ have_dict = checkAspellData(config, userdir, dataDirectory(), dictDirectory(), lang, variety);
+ if (!have_dict) {
+ LYXERR(Debug::FILES, "aspell sysdir dir: " << sysdir);
+ have_dict = checkAspellData(config, sysdir, dataDirectory(), dictDirectory(), lang, variety);
}
if (!have_dict) {
- // check for macports data
- have_dict = checkAspellData(config, ASPELL_MACPORTS, ASPELL_MACPORTS_DATA, ASPELL_MACPORTS_DICT, lang, variety);
+ // check for package data of OS installation
+ have_dict = checkAspellData(config, osPackageBase(), osPackageDataDirectory(), osPackageDictDirectory(), lang, variety);
}
-#endif
return config ;
}
-AspellSpeller * AspellChecker::Private::addSpeller(string const & lang,
- string const & variety)
+void AspellChecker::Private::initSessionDictionary(
+ Speller const & speller,
+ PersonalWordList * pd)
{
- Speller m;
+ AspellSpeller * aspell = to_aspell_speller(speller.e_speller);
+ aspell_speller_clear_session(aspell);
+ docstring_list::const_iterator it = pd->begin();
+ docstring_list::const_iterator et = pd->end();
+ for (; it != et; ++it) {
+ string const word_to_add = to_utf8(*it);
+ aspell_speller_add_to_session(aspell, word_to_add.c_str(), -1);
+ }
+ it = speller.ignored_words_.begin();
+ et = speller.ignored_words_.end();
+ for (; it != et; ++it) {
+ string const word_to_add = to_utf8(*it);
+ aspell_speller_add_to_session(aspell, word_to_add.c_str(), -1);
+ }
+}
+
- m.config = getConfig(lang, variety);
+AspellSpeller * AspellChecker::Private::addSpeller(Language const * lang)
+{
+ Speller m;
+ string const code = lang->code();
+ string const variety = lang->variety();
+ m.config = getConfig(code, variety);
// Aspell supports both languages and varieties (such as German
// old vs. new spelling). The respective naming convention is
// lang_REGION-variety (e.g. de_DE-alt).
- aspell_config_replace(m.config, "lang", lang.c_str());
+ aspell_config_replace(m.config, "lang", code.c_str());
if (!variety.empty())
aspell_config_replace(m.config, "variety", variety.c_str());
// Set the encoding to utf-8.
if (aspell_error_number(m.e_speller) != 0) {
// FIXME: We should indicate somehow that this language is not supported.
LYXERR(Debug::FILES, "aspell error: " << aspell_error_message(m.e_speller));
+ delete_aspell_can_have_error(m.e_speller);
+ delete_aspell_config(m.config);
+ m.config = 0;
+ m.e_speller = 0;
+ } else {
+ PersonalWordList * pd = new PersonalWordList(lang->lang());
+ pd->load();
+ personal_[lang->lang()] = pd;
+ initSessionDictionary(m, pd);
}
-
- spellers_[spellerID(lang, variety)] = m;
- return to_aspell_speller(m.e_speller);
+
+ spellers_[lang->lang()] = m;
+ return m.e_speller ? to_aspell_speller(m.e_speller) : 0;
}
-AspellSpeller * AspellChecker::Private::speller(string const & lang,
- string const & variety)
+AspellSpeller * AspellChecker::Private::speller(Language const * lang)
{
- Spellers::iterator it = spellers_.find(spellerID(lang, variety));
+ Spellers::iterator it = spellers_.find(lang->lang());
if (it != spellers_.end())
return to_aspell_speller(it->second.e_speller);
- return addSpeller(lang, variety);
+ return addSpeller(lang);
}
-string const AspellChecker::Private::spellerID(string const & lang,
- string const & variety)
+SpellChecker::Result AspellChecker::Private::check(
+ AspellSpeller * m, string const & word)
+ const
{
- if (variety.empty())
- return lang;
- return lang + "-" + variety;
+ int const word_ok = aspell_speller_check(m, word.c_str(), -1);
+ LASSERT(word_ok != -1, /**/);
+ return (word_ok) ? WORD_OK : UNKNOWN_WORD;
+}
+
+void AspellChecker::Private::accept(Speller & speller, WordLangTuple const & word)
+{
+ speller.ignored_words_.push_back(word.word());
+}
+
+
+/// personal word list interface
+void AspellChecker::Private::remove(WordLangTuple const & word)
+{
+ PersonalWordList * pd = personal_[word.lang()->lang()];
+ if (!pd)
+ return;
+ pd->remove(word.word());
+ Spellers::iterator it = spellers_.find(word.lang()->lang());
+ if (it != spellers_.end()) {
+ initSessionDictionary(it->second, pd);
+ }
+}
+
+
+void AspellChecker::Private::insert(WordLangTuple const & word)
+{
+ Spellers::iterator it = spellers_.find(word.lang()->lang());
+ if (it != spellers_.end()) {
+ AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
+ aspell_speller_add_to_session(speller, to_utf8(word.word()).c_str(), -1);
+ PersonalWordList * pd = personal_[word.lang()->lang()];
+ if (!pd)
+ return;
+ pd->insert(word.word());
+ }
+}
+
+bool AspellChecker::Private::learned(WordLangTuple const & word)
+{
+ PersonalWordList * pd = personal_[word.lang()->lang()];
+ if (!pd)
+ return false;
+ return pd->exists(word.word());
}
SpellChecker::Result AspellChecker::check(WordLangTuple const & word)
{
- AspellSpeller * m =
- d->speller(word.lang()->code(), word.lang()->variety());
+ AspellSpeller * m = d->speller(word.lang());
if (!m)
- return OK;
+ return WORD_OK;
if (word.word().empty())
// MSVC compiled Aspell doesn't like it.
- return OK;
+ return WORD_OK;
+
+ string const word_str = to_utf8(word.word());
+ SpellChecker::Result rc = d->check(m, word_str);
+ return (rc == WORD_OK && d->learned(word)) ? LEARNED_WORD : rc;
+}
- int const word_ok = aspell_speller_check(m, to_utf8(word.word()).c_str(), -1);
- LASSERT(word_ok != -1, /**/);
- return (word_ok) ? OK : UNKNOWN_WORD;
+void AspellChecker::advanceChangeNumber()
+{
+ nextChangeNumber();
}
void AspellChecker::insert(WordLangTuple const & word)
{
- Spellers::iterator it = d->spellers_.find(
- d->spellerID(word.lang()->code(), word.lang()->variety()));
- if (it != d->spellers_.end()) {
- AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
- aspell_speller_add_to_personal(speller, to_utf8(word.word()).c_str(), -1);
- }
+ d->insert(word);
+ advanceChangeNumber();
}
void AspellChecker::accept(WordLangTuple const & word)
{
- Spellers::iterator it = d->spellers_.find(
- d->spellerID(word.lang()->code(), word.lang()->variety()));
+ Spellers::iterator it = d->spellers_.find(word.lang()->lang());
if (it != d->spellers_.end()) {
AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
aspell_speller_add_to_session(speller, to_utf8(word.word()).c_str(), -1);
+ d->accept(it->second, word);
+ advanceChangeNumber();
}
}
docstring_list & suggestions)
{
suggestions.clear();
- AspellSpeller * m =
- d->speller(wl.lang()->code(), wl.lang()->variety());
+ AspellSpeller * m = d->speller(wl.lang());
if (!m)
return;
delete_aspell_string_enumeration(els);
}
+void AspellChecker::remove(WordLangTuple const & word)
+{
+ d->remove(word);
+ advanceChangeNumber();
+}
bool AspellChecker::hasDictionary(Language const * lang) const
{
if (lang) {
for (; it != end && !have; ++it) {
- have = isValidDictionary(it->second.config, lang->code(), lang->variety());
+ have = it->second.config && d->isValidDictionary(it->second.config, lang->code(), lang->variety());
}
if (!have) {
- AspellConfig * config = getConfig(lang->code(), lang->variety());
- have = isValidDictionary(config, lang->code(), lang->variety());
+ AspellConfig * config = d->getConfig(lang->code(), lang->variety());
+ have = d->isValidDictionary(config, lang->code(), lang->variety());
delete_aspell_config(config);
}
}