X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FHunspellChecker.cpp;h=31b629671e653350e1b00a857fc022d0e5e756ba;hb=0ce10160daadc904ab1221eaeef0d005694f0f0c;hp=30d799a7f2243ad9d6a26b5cd01f358202d87d6d;hpb=61ceded4f26abcf8aa40ce301b0ee78d374fbfab;p=lyx.git diff --git a/src/HunspellChecker.cpp b/src/HunspellChecker.cpp index 30d799a7f2..31b629671e 100644 --- a/src/HunspellChecker.cpp +++ b/src/HunspellChecker.cpp @@ -11,6 +11,7 @@ #include #include "HunspellChecker.h" +#include "PersonalWordList.h" #include "LyXRC.h" #include "WordLangTuple.h" @@ -20,6 +21,7 @@ #include "support/debug.h" #include "support/docstring_list.h" #include "support/filetools.h" +#include "support/Package.h" #include "support/FileName.h" #include "support/gettext.h" #include "support/lassert.h" @@ -30,6 +32,7 @@ #include #include +#include using namespace std; using namespace lyx::support; @@ -40,108 +43,288 @@ namespace lyx { namespace { typedef map Spellers; +typedef map LangPersonalWordList; + +typedef vector IgnoreList; } // anon namespace + struct HunspellChecker::Private { - Private() {} - + Private(); ~Private(); - Hunspell * addSpeller(string const & lang); - Hunspell * speller(string const & lang); - + void cleanCache(); + void setUserPath(std::string const & path); + const string dictPath(int selector); + bool haveLanguageFiles(string const & hpath); + bool haveDictionary(Language const * lang, string & hpath); + bool haveDictionary(Language const * lang); + int numDictionaries() const; + Hunspell * addSpeller(Language const * lang, string & hpath); + Hunspell * addSpeller(Language const * lang); + Hunspell * speller(Language const * lang); + /// ignored words + bool isIgnored(WordLangTuple const & wl) const; + /// personal word list interface + void remove(WordLangTuple const & wl); + void insert(WordLangTuple const & wl); + bool learned(WordLangTuple const & wl); /// the spellers Spellers spellers_; + /// + IgnoreList ignored_; + /// + LangPersonalWordList personal_; + /// + std::string user_path_; + + /// the location below system/user directory + /// there the aff+dic files lookup will happen + const string dictDirectory(void) const { return "dicts"; } + int maxLookupSelector(void) const { return 4; } + const string HunspellDictionaryName(Language const * lang) { + return lang->variety().empty() + ? lang->code() + : lang->code() + "-" + lang->variety(); + } + const string osPackageDictDirectory(void) { + return "/usr/share/myspell"; + } }; +HunspellChecker::Private::Private() +{ + setUserPath(lyxrc.hunspelldir_path); +} + + HunspellChecker::Private::~Private() +{ + cleanCache(); +} + + +void HunspellChecker::Private::setUserPath(std::string const & path) +{ + if (user_path_ != lyxrc.hunspelldir_path) { + cleanCache(); + user_path_ = path; + } +} + + +void HunspellChecker::Private::cleanCache() { Spellers::iterator it = spellers_.begin(); Spellers::iterator end = spellers_.end(); for (; it != end; ++it) { delete it->second; + it->second = 0; + } + + 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; } } -namespace { -bool haveLanguageFiles(string const & hpath) +bool HunspellChecker::Private::haveLanguageFiles(string const & hpath) { FileName const affix(hpath + ".aff"); FileName const dict(hpath + ".dic"); - if (!affix.isReadableFile()) { - // FIXME: We should indicate somehow that this language is not - // supported. - LYXERR(Debug::FILES, "Hunspell affix file " << affix << " does not exist"); - return false; + return affix.isReadableFile() && dict.isReadableFile(); +} + + +const string HunspellChecker::Private::dictPath(int selector) +{ + switch (selector) { + case 3: + return addName(osPackageDictDirectory(),dictDirectory()); + break; + case 2: + return addName(package().system_support().absFileName(),dictDirectory()); + break; + case 1: + return addName(package().user_support().absFileName(),dictDirectory()); + break; + default: + return user_path_; } - if (!dict.isReadableFile()) { - LYXERR(Debug::FILES, "Hunspell dictionary file " << dict << " does not exist"); +} + + +bool HunspellChecker::Private::haveDictionary(Language const * lang, string & hpath) +{ + if (hpath.empty()) return false; + + LYXERR(Debug::FILES, "check hunspell path: " << hpath + << " for language " << (lang ? lang->lang() : "NULL" )); + + string h_path = addName(hpath, HunspellDictionaryName(lang)); + // first we try lang code+variety + if (haveLanguageFiles(h_path)) { + LYXERR(Debug::FILES, " found " << h_path); + hpath = h_path; + return true; } + // another try with code, '_' replaced by '-' + h_path = addName(hpath, subst(lang->code(), '_', '-')); + if (!haveLanguageFiles(h_path)) + return false; + LYXERR(Debug::FILES, " found " << h_path); + hpath = h_path; return true; } + + +bool HunspellChecker::Private::haveDictionary(Language const * lang) +{ + bool result = false; + + setUserPath(lyxrc.hunspelldir_path); + for (int p = 0; !result && p < maxLookupSelector(); ++p) { + string lpath = dictPath(p); + result = haveDictionary(lang, lpath); + } + // FIXME: if result is false... + // we should indicate somehow that this language is not + // supported, probably by popping a warning. But we'll need to + // remember which warnings we've issued. + return result; } -Hunspell * HunspellChecker::Private::addSpeller(string const & lang) +Hunspell * HunspellChecker::Private::speller(Language const * lang) { - string hunspell_path = lyxrc.hunspelldir_path; - LYXERR(Debug::FILES, "hunspell path: " << external_path(hunspell_path)); - if (hunspell_path.empty()) { - // FIXME We'd like to issue a better error message here, but there seems - // to be a problem about thread safety, or something of the sort. If - // we issue the message using frontend::Alert, then the code comes - // back through here while the box is waiting, and causes some kind - // of crash. - static bool warned = false; - if (!warned) { - warned = true; - LYXERR0("Hunspell path not set."); - //frontend::Alert::error(_("Hunspell Path Not Found"), - // _("You must set the Hunspell dictionary path in Tools>Preferences>Paths.")); - } + setUserPath(lyxrc.hunspelldir_path); + Spellers::iterator it = spellers_.find(lang->lang()); + if (it != spellers_.end()) + return it->second; + return addSpeller(lang); +} + + +Hunspell * HunspellChecker::Private::addSpeller(Language const * lang,string & path) +{ + if (!haveDictionary(lang, path)) { + spellers_[lang->lang()] = 0; return 0; } - hunspell_path = external_path(addName(hunspell_path, lang)); - if (!haveLanguageFiles(hunspell_path)) { - // try with '_' replaced by '-' - hunspell_path = subst(hunspell_path, '_', '-'); - if (!haveLanguageFiles(hunspell_path)) { - // FIXME: We should indicate somehow that this language is not - // supported, probably by popping a warning. But we'll need to - // remember which warnings we've issued. - return 0; + FileName const affix(path + ".aff"); + FileName const dict(path + ".dic"); + Hunspell * h = new Hunspell(affix.absFileName().c_str(), dict.absFileName().c_str()); + LYXERR(Debug::FILES, "Hunspell speller for langage " << lang << " at " << dict << " found"); + spellers_[lang->lang()] = h; + return h; +} + + +Hunspell * HunspellChecker::Private::addSpeller(Language const * lang) +{ + Hunspell * h = 0; + for (int p = 0; p < maxLookupSelector() && 0 == h; ++p) { + string lpath = dictPath(p); + h = addSpeller(lang, lpath); + } + if (h) { + string const encoding = h->get_dic_encoding(); + PersonalWordList * pd = new PersonalWordList(lang->lang()); + pd->load(); + personal_[lang->lang()] = pd; + docstring_list::const_iterator it = pd->begin(); + docstring_list::const_iterator et = pd->end(); + for (; it != et; ++it) { + string const word_to_add = to_iconv_encoding(*it, encoding); + h->add(word_to_add.c_str()); } } - FileName const affix(hunspell_path + ".aff"); - FileName const dict(hunspell_path + ".dic"); - Hunspell * h = new Hunspell(affix.absFilename().c_str(), dict.absFilename().c_str()); - spellers_[lang] = h; return h; } -Hunspell * HunspellChecker::Private::speller(string const & lang) +int HunspellChecker::Private::numDictionaries() const { - Spellers::iterator it = spellers_.find(lang); - if (it != spellers_.end()) - return it->second; - - return addSpeller(lang); + int result = 0; + Spellers::const_iterator it = spellers_.begin(); + Spellers::const_iterator et = spellers_.end(); + + for (; it != et; ++it) + result += it->second != 0; + return result; } -HunspellChecker::HunspellChecker(): d(new Private) +bool HunspellChecker::Private::isIgnored(WordLangTuple const & wl) const { + IgnoreList::const_iterator it = ignored_.begin(); + for (; it != ignored_.end(); ++it) { + if (it->lang()->code() != wl.lang()->code()) + continue; + if (it->word() == wl.word()) + return true; + } + return false; +} + +/// personal word list interface +void HunspellChecker::Private::remove(WordLangTuple const & wl) +{ + Hunspell * h = speller(wl.lang()); + if (!h) + return; + string const encoding = h->get_dic_encoding(); + string const word_to_check = to_iconv_encoding(wl.word(), encoding); + h->remove(word_to_check.c_str()); + PersonalWordList * pd = personal_[wl.lang()->lang()]; + if (!pd) + return; + pd->remove(wl.word()); } +void HunspellChecker::Private::insert(WordLangTuple const & wl) +{ + Hunspell * h = speller(wl.lang()); + if (!h) + return; + string const encoding = h->get_dic_encoding(); + string const word_to_check = to_iconv_encoding(wl.word(), encoding); + h->add(word_to_check.c_str()); + PersonalWordList * pd = personal_[wl.lang()->lang()]; + if (!pd) + return; + pd->insert(wl.word()); +} + + +bool HunspellChecker::Private::learned(WordLangTuple const & wl) +{ + PersonalWordList * pd = personal_[wl.lang()->lang()]; + if (!pd) + return false; + return pd->exists(wl.word()); +} + + +HunspellChecker::HunspellChecker() + : d(new Private) +{} + + HunspellChecker::~HunspellChecker() { delete d; @@ -150,20 +333,26 @@ HunspellChecker::~HunspellChecker() SpellChecker::Result HunspellChecker::check(WordLangTuple const & wl) { - string const word_to_check = to_utf8(wl.word()); - Hunspell * h = d->speller(wl.lang_code()); + if (d->isIgnored(wl)) + return WORD_OK; + + Hunspell * h = d->speller(wl.lang()); if (!h) - return OK; + return NO_DICTIONARY; int info; + + string const encoding = h->get_dic_encoding(); + string const word_to_check = to_iconv_encoding(wl.word(), encoding); + if (h->spell(word_to_check.c_str(), &info)) - return OK; + return d->learned(wl) ? LEARNED_WORD : WORD_OK; if (info & SPELL_COMPOUND) { // FIXME: What to do with that? LYXERR(Debug::FILES, "Hunspell compound word found " << word_to_check); } if (info & SPELL_FORBIDDEN) { - // FIXME: What to do with that? + // This was removed from personal dictionary LYXERR(Debug::FILES, "Hunspell explicit forbidden word found " << word_to_check); } @@ -171,19 +360,33 @@ SpellChecker::Result HunspellChecker::check(WordLangTuple const & wl) } +void HunspellChecker::advanceChangeNumber() +{ + nextChangeNumber(); +} + + void HunspellChecker::insert(WordLangTuple const & wl) { - string const word_to_check = to_utf8(wl.word()); - Hunspell * h = d->speller(wl.lang_code()); - if (!h) - return; - h->add(word_to_check.c_str()); + d->insert(wl); + LYXERR(Debug::GUI, "learn word: \"" << wl.word() << "\"") ; + advanceChangeNumber(); +} + + +void HunspellChecker::remove(WordLangTuple const & wl) +{ + d->remove(wl); + LYXERR(Debug::GUI, "unlearn word: \"" << wl.word() << "\"") ; + advanceChangeNumber(); } -void HunspellChecker::accept(WordLangTuple const &) +void HunspellChecker::accept(WordLangTuple const & wl) { - // FIXME: not implemented! + d->ignored_.push_back(wl); + LYXERR(Debug::GUI, "ignore word: \"" << wl.word() << "\"") ; + advanceChangeNumber(); } @@ -191,20 +394,54 @@ void HunspellChecker::suggest(WordLangTuple const & wl, docstring_list & suggestions) { suggestions.clear(); - string const word_to_check = to_utf8(wl.word()); - Hunspell * h = d->speller(wl.lang_code()); + Hunspell * h = d->speller(wl.lang()); if (!h) return; + string const encoding = h->get_dic_encoding(); + string const word_to_check = to_iconv_encoding(wl.word(), encoding); char ** suggestion_list; int const suggestion_number = h->suggest(&suggestion_list, word_to_check.c_str()); if (suggestion_number <= 0) return; for (int i = 0; i != suggestion_number; ++i) - suggestions.push_back(from_utf8(suggestion_list[i])); + suggestions.push_back(from_iconv_encoding(suggestion_list[i], encoding)); h->free_list(&suggestion_list, suggestion_number); } +void HunspellChecker::stem(WordLangTuple const & wl, + docstring_list & suggestions) +{ + suggestions.clear(); + Hunspell * h = d->speller(wl.lang()); + if (!h) + return; + string const encoding = h->get_dic_encoding(); + string const word_to_check = to_iconv_encoding(wl.word(), encoding); + char ** suggestion_list; + int const suggestion_number = h->stem(&suggestion_list, word_to_check.c_str()); + if (suggestion_number <= 0) + return; + for (int i = 0; i != suggestion_number; ++i) + suggestions.push_back(from_iconv_encoding(suggestion_list[i], encoding)); + h->free_list(&suggestion_list, suggestion_number); +} + + +bool HunspellChecker::hasDictionary(Language const * lang) const +{ + if (!lang) + return false; + return d->haveDictionary(lang); +} + + +int HunspellChecker::numDictionaries() const +{ + return d->numDictionaries(); +} + + docstring const HunspellChecker::error() { return docstring();