]> git.lyx.org Git - lyx.git/blobdiff - src/HunspellChecker.cpp
Fairly trivial change here: Just protect against inheriting limits to
[lyx.git] / src / HunspellChecker.cpp
index f5b9d0c61a88158662e9af684042eca3b9b59ceb..e055ae6ab694e362aff699b8135a1e1d08d1642e 100644 (file)
@@ -11,6 +11,7 @@
 #include <config.h>
 
 #include "HunspellChecker.h"
+#include "PersonalWordList.h"
 
 #include "LyXRC.h"
 #include "WordLangTuple.h"
@@ -42,6 +43,8 @@ namespace lyx {
 namespace {
 
 typedef map<std::string, Hunspell *> Spellers;
+typedef map<std::string, PersonalWordList *> LangPersonalWordList;
+
 typedef vector<WordLangTuple> IgnoreList;
 
 } // anon namespace
@@ -49,32 +52,46 @@ typedef vector<WordLangTuple> IgnoreList;
 
 struct HunspellChecker::Private
 {
-       Private() {}
-
+       Private();
        ~Private();
 
        const string dictPath(int selector);
        bool haveLanguageFiles(string const & hpath);
-       bool haveDictionary(string const & lang, string & hpath);
-       bool haveDictionary(string const & lang);
-       Hunspell * addSpeller(string const & lang, string & hpath);
-       Hunspell * addSpeller(string const & lang);
-       Hunspell * speller(string const & lang);
+       bool haveDictionary(Language const * lang, string & hpath);
+       bool haveDictionary(Language const * lang);
+       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_;
 
        /// the location below system/user directory
        /// there the aff+dic files lookup will happen
-       const string dictDirectory(void) const { return "dict"; }
+       const string dictDirectory(void) const { return "dicts"; }
        int maxLookupSelector(void) const { return 3; }
+       const string HunspellDictionaryName(Language const * lang) {
+               return lang->variety().empty() 
+                       ? lang->code()
+                       : lang->code() + "-" + lang->variety();
+       }
 };
 
 
+HunspellChecker::Private::Private()
+{
+}
+
+
 HunspellChecker::Private::~Private()
 {
        Spellers::iterator it = spellers_.begin();
@@ -83,6 +100,17 @@ HunspellChecker::Private::~Private()
        for (; it != end; ++it) {
                if ( 0 != it->second) delete it->second;
        }
+
+       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;
+       }
 }
 
 
@@ -98,10 +126,10 @@ const string HunspellChecker::Private::dictPath(int selector)
 {
        switch (selector) {
        case 2:
-               return addName(lyx::support::package().system_support().absFileName(),dictDirectory());
+               return addName(package().system_support().absFileName(),dictDirectory());
                break;
        case 1:
-               return addName(lyx::support::package().user_support().absFileName(),dictDirectory());
+               return addName(package().user_support().absFileName(),dictDirectory());
                break;
        default:
                return lyxrc.hunspelldir_path;
@@ -109,54 +137,58 @@ const string HunspellChecker::Private::dictPath(int selector)
 }
 
 
-bool HunspellChecker::Private::haveDictionary(string const & lang, string & hpath)
+bool HunspellChecker::Private::haveDictionary(Language const * lang, string & hpath)
 {
        if (hpath.empty()) {
                return false;
        }
 
        LYXERR(Debug::FILES, "check hunspell path: " << hpath << " for language " << lang);
-       string h_path = addName(hpath, lang);
+       string h_path = addName(hpath, HunspellDictionaryName(lang));
+       // first we try lang code+variety
+       if (haveLanguageFiles(h_path)) {
+               hpath = h_path;
+               return true;
+       }
+       // another try with code, '_' replaced by '-'
+       h_path = addName(hpath, subst(lang->code(), '_', '-'));
        if (!haveLanguageFiles(h_path)) {
-               // try with '_' replaced by '-'
-               h_path = addName(hpath, subst(lang, '_', '-'));
-               if (!haveLanguageFiles(h_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 false;
-               }
+               return false;
        }
        hpath = h_path;
        return true;
 }
 
 
-bool HunspellChecker::Private::haveDictionary(string const & lang)
+bool HunspellChecker::Private::haveDictionary(Language const * lang)
 {
        bool result = false;
        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::speller(string const & lang)
+Hunspell * HunspellChecker::Private::speller(Language const * lang)
 {
-       Spellers::iterator it = spellers_.find(lang);
+       Spellers::iterator it = spellers_.find(lang->lang());
        if (it != spellers_.end())
                return it->second;
-       
+
        return addSpeller(lang);
 }
 
 
-Hunspell * HunspellChecker::Private::addSpeller(string const & lang,string & path)
+Hunspell * HunspellChecker::Private::addSpeller(Language const * lang,string & path)
 {
        if (!haveDictionary(lang, path)) {
-               spellers_[lang] = 0;
+               spellers_[lang->lang()] = 0;
                return 0;
        }
 
@@ -164,18 +196,30 @@ Hunspell * HunspellChecker::Private::addSpeller(string const & lang,string & pat
        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] = h;
+       spellers_[lang->lang()] = h;
        return h;
 }
 
 
-Hunspell * HunspellChecker::Private::addSpeller(string const & lang)
+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 (0 != 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());
+               }
+       }
        return h;
 }
 
@@ -192,6 +236,45 @@ bool HunspellChecker::Private::isIgnored(WordLangTuple const & wl) const
        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)
 {
@@ -207,25 +290,25 @@ HunspellChecker::~HunspellChecker()
 SpellChecker::Result HunspellChecker::check(WordLangTuple const & wl)
 {
        if (d->isIgnored(wl))
-               return OK;
+               return WORD_OK;
 
-       Hunspell * h = d->speller(wl.lang()->code());
+       Hunspell * h = d->speller(wl.lang());
        if (!h)
-               return OK;
+               return WORD_OK;
        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);
        }
 
@@ -233,19 +316,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 & wl)
 {
        d->ignored_.push_back(wl);
+       LYXERR(Debug::GUI, "ignore word: \"" << wl.word() << "\"") ;
+       advanceChangeNumber();
 }
 
 
@@ -253,7 +350,7 @@ void HunspellChecker::suggest(WordLangTuple const & wl,
        docstring_list & suggestions)
 {
        suggestions.clear();
-       Hunspell * h = d->speller(wl.lang()->code());
+       Hunspell * h = d->speller(wl.lang());
        if (!h)
                return;
        string const encoding = h->get_dic_encoding();
@@ -272,7 +369,7 @@ bool HunspellChecker::hasDictionary(Language const * lang) const
 {
        if (!lang)
                return false;
-       return (d->haveDictionary(lang->code()));
+       return (d->haveDictionary(lang));
 }