src/frontends/controllers/ControlSpellchecker.C

   1 /**
   2  * \file ControlSpellchecker.C
   3  * Copyright 2001 the LyX Team
   4  * Read the file COPYING
   5  *
   6  * \author Edwin Leuven <leuven@fee.uva.nl>
   7  */
   8
   9 #include <config.h>
  10
  11 #ifdef __GNUG__
  12 #pragma implementation
  13 #endif
  14
  15 #include "ControlSpellchecker.h"
  16 #include "buffer.h"
  17 #include "lyxrc.h"
  18 #include "BufferView.h"
  19 #include "lyxtext.h"
  20 #include "gettext.h"
  21 #include "language.h"
  22
  23 #include "ViewBase.h"
  24 #include "Dialogs.h"
  25 #include "Liason.h"
  26
  27 #include "frontends/LyXView.h"
  28 #include "frontends/Alert.h"
  29
  30 #include "support/lstrings.h"
  31
  32 #include "ispell.h"
  33 #ifdef USE_PSPELL
  34 # include "pspell.h"
  35 #endif
  36
  37 ControlSpellchecker::ControlSpellchecker(LyXView & lv, Dialogs & d)
  38         : ControlDialogBD(lv, d),
  39           rtl_(false), newval_(0.0), oldval_(0), newvalue_(0), count_(0),
  40           stop_(false), speller_(0)
  41 {}
  42
  43
  44 void ControlSpellchecker::setParams()
  45 {
  46         if (!speller_) {
  47                 // create spell object
  48                 string tmp;
  49 #ifdef USE_PSPELL
  50                 if (lyxrc.use_pspell) {
  51                         tmp = (lyxrc.isp_use_alt_lang) ?
  52                                 lyxrc.isp_alt_lang : lv_.buffer()->params.language->code();
  53
  54                         speller_ = new PSpell(lv_.view()->buffer()->params, tmp);
  55                 } else {
  56 #endif
  57                         tmp = (lyxrc.isp_use_alt_lang) ?
  58                                 lyxrc.isp_alt_lang : lv_.buffer()->params.language->lang();
  59
  60                         speller_ = new ISpell(lv_.view()->buffer()->params, tmp);
  61 #ifdef USE_PSPELL
  62                 }
  63 #endif
  64
  65                 if (lyxrc.isp_use_alt_lang) {
  66                         Language const * lang = languages.getLanguage(tmp);
  67                         if (lang)
  68                                 rtl_ = lang->RightToLeft();
  69                 } else {
  70                         rtl_ = lv_.buffer()->params.language->RightToLeft();
  71                 }
  72
  73                 if (!speller_->error().empty()) {
  74                         clearParams();
  75                         return;
  76                 }
  77         }
  78 }
  79
  80
  81 void ControlSpellchecker::check()
  82 {
  83         SpellBase::Result res = SpellBase::OK;
  84         stop_ = false;
  85
  86         // clear any old selection
  87         LyXText * text = lv_.view()->getLyXText();
  88         lv_.view()->toggleSelection(true);
  89         lv_.view()->update(text, BufferView::SELECT);
  90
  91         while ((res == SpellBase::OK || res == SpellBase::IGNORE) && !stop_) {
  92                 word_ = lv_.view()->nextWord(newval_);
  93
  94                 if (word_.word().empty()) {
  95                         clearParams();
  96                         break;
  97                 }
  98
  99                 ++count_;
 100
 101                 // Update slider if and only if value has changed
 102                 newvalue_ = int(100.0 * newval_);
 103                 if (newvalue_!= oldval_) {
 104                         oldval_ = newvalue_;
 105                         // set progress bar
 106                         view().partialUpdate(0);
 107                 }
 108
 109                 if (!speller_->alive()) {
 110                         clearParams();
 111                         stop();
 112                         return;
 113                 }
 114
 115                 res = speller_->check(word_);
 116         }
 117
 118         if (!stop_ && !word_.word().empty())
 119                 lv_.view()->selectLastWord();
 120
 121         // set suggestions
 122         if (res != SpellBase::OK && res != SpellBase::IGNORE) {
 123                 view().partialUpdate(1);
 124         }
 125 }
 126
 127
 128 void ControlSpellchecker::replace(string const & replacement)
 129 {
 130         lv_.view()->replaceWord(replacement);
 131         // fix up the count
 132         --count_;
 133         check();
 134 }
 135
 136
 137 void ControlSpellchecker::replaceAll(string const & replacement)
 138 {
 139         // TODO: add to list
 140         replace(replacement);
 141 }
 142
 143
 144 void ControlSpellchecker::insert()
 145 {
 146         speller_->insert(word_);
 147         check();
 148 }
 149
 150
 151 string ControlSpellchecker::getSuggestion()
 152 {
 153         string miss(speller_->nextMiss());
 154
 155         if (rtl_)
 156                 std::reverse(miss.begin(), miss.end());
 157
 158         return miss;
 159 }
 160
 161
 162 string ControlSpellchecker::getWord()
 163 {
 164         string tmp = word_.word();
 165         if (rtl_)
 166                 std::reverse(tmp.begin(), tmp.end());
 167         return tmp;
 168 }
 169
 170
 171 void ControlSpellchecker::ignoreAll()
 172 {
 173         speller_->accept(word_);
 174         check();
 175 }
 176
 177
 178 void ControlSpellchecker::stop()
 179 {
 180         stop_ = true;
 181         lv_.view()->endOfSpellCheck();
 182 }
 183
 184
 185 void ControlSpellchecker::clearParams()
 186 {
 187         if (!speller_) return;
 188
 189         if (speller_->alive()) {
 190                 speller_->close();
 191                 message_ = tostr(count_);
 192                 if (count_ != 1) {
 193                         message_ += _(" words checked.");
 194
 195                 } else {
 196                         message_ += _(" word checked.");
 197                 }
 198                 message_ = "\n" + message_;
 199                 message_ = _("Spellchecking completed! ") + message_;
 200
 201         } else {
 202                 message_ = speller_->error();
 203                 speller_->cleanUp();
 204                 if (message_.empty())
 205                     message_ = _("The spell checker has died for some reason.\n"
 206                                  "Maybe it has been killed.");
 207
 208                 // make sure that the dialog is not launched
 209                 emergency_exit_ = true;
 210                 Alert::alert("The spellchecker has failed", message_);
 211         }
 212
 213         delete speller_;
 214
 215         lv_.view()->endOfSpellCheck();
 216
 217         // show closing message if any words were checked.
 218         if (count_ > 0)
 219                 view().partialUpdate(2);
 220
 221         // reset values to initial
 222         rtl_ = false;
 223         newval_ = 0.0;
 224         oldval_ = 0;
 225         newvalue_ = 0;
 226         count_ = 0;
 227         message_.erase();
 228         stop_ = false;
 229         speller_ = 0;
 230 }