src/frontends/controllers/ControlSpellchecker.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 2001 The LyX Team.
   7  *
   8  * ======================================================
   9  *
  10  * \file ControlSpellchecker.C
  11  * \author Edwin Leuven <leuven@fee.uva.nl>
  12  */
  13
  14 #include <config.h>
  15
  16 #ifdef __GNUG__
  17 #pragma implementation
  18 #endif
  19
  20 #include FORMS_H_LOCATION
  21
  22 #ifdef HAVE_SYS_SELECT_H
  23 # ifdef HAVE_STRINGS_H
  24    // <strings.h> is needed at least on AIX because FD_ZERO uses bzero().
  25    // BUT we cannot include both string.h and strings.h on Irix 6.5 :(
  26 #  ifdef _AIX
  27 #   include <strings.h>
  28 #  endif
  29 # endif
  30 #include <sys/select.h>
  31 #endif
  32
  33 #include "buffer.h"
  34 #include "lyxrc.h"
  35 #include "BufferView.h"
  36 #include "LyXView.h"
  37 #include "gettext.h"
  38 #include "support/lstrings.h"
  39 #include "language.h"
  40
  41 #include "ViewBase.h"
  42 #include "ButtonControllerBase.h"
  43 #include "ControlSpellchecker.h"
  44 #include "Dialogs.h"
  45 #include "Liason.h"
  46
  47 # include "sp_ispell.h"
  48 #ifdef USE_PSPELL
  49 # include "sp_pspell.h"
  50 #endif
  51
  52 #include "debug.h"
  53
  54 using SigC::slot;
  55
  56 ControlSpellchecker::ControlSpellchecker(LyXView & lv, Dialogs & d)
  57         : ControlDialog<ControlConnectBD>(lv, d),
  58           rtl_(false), newval_(0.0), oldval_(0), newvalue_(0), count_(0),
  59           stop_(false), result_(SpellBase::ISP_UNKNOWN), speller_(0)
  60 {
  61         d_.showSpellchecker.connect(SigC::slot(this, &ControlSpellchecker::show));
  62 }
  63
  64
  65 void ControlSpellchecker::setParams()
  66 {
  67         if (!speller_) {
  68                 // create spell object
  69                 string tmp;
  70 #ifdef USE_PSPELL
  71                 if (lyxrc.use_pspell) {
  72                         tmp = (lyxrc.isp_use_alt_lang) ?
  73                                 lyxrc.isp_alt_lang : lv_.buffer()->params.language->code();
  74
  75                         speller_ = new PSpell(lv_.view()->buffer()->params, tmp);
  76                 } else {
  77 #endif
  78                         tmp = (lyxrc.isp_use_alt_lang) ?
  79                                 lyxrc.isp_alt_lang : lv_.buffer()->params.language->lang();
  80
  81                         speller_ = new ISpell(lv_.view()->buffer()->params, tmp);
  82 #ifdef USE_PSPELL
  83                 }
  84 #endif
  85
  86                 if (lyxrc.isp_use_alt_lang) {
  87                         Language const * lang = languages.getLanguage(tmp);
  88                         if (lang)
  89                                 rtl_ = lang->RightToLeft();
  90                 } else {
  91                         rtl_ = lv_.buffer()->params.language->RightToLeft();
  92                 }
  93
  94                 if (speller_->error() != 0) {
  95                         message_ = speller_->error();
  96                         // show error message
  97                         view().partialUpdate(2);
  98                         clearParams();
  99                         return;
 100                 }
 101         }
 102 }
 103
 104
 105 void ControlSpellchecker::check()
 106 {
 107         result_ = SpellBase::ISP_UNKNOWN;
 108         stop_ = false;
 109
 110         while (result_!=SpellBase::ISP_MISSED && !stop_) {
 111                 word_ = lv_.view()->nextWord(newval_);
 112
 113                 if (word_.empty()) {
 114                         clearParams();
 115                         break;
 116                 }
 117
 118                 ++count_;
 119
 120                 // Update slider if and only if value has changed
 121                 newvalue_ = int(100.0*newval_);
 122                 if (newvalue_!= oldval_) {
 123                         oldval_ = newvalue_;
 124                         // set progress bar
 125                         view().partialUpdate(0);
 126                 }
 127
 128                 if (!speller_->alive()) clearParams();
 129
 130                 result_ = speller_->check(word_);
 131         }
 132
 133         if (!stop_ && !word_.empty())
 134                 lv_.view()->selectLastWord();
 135
 136         // set suggestions
 137         if (result_==SpellBase::ISP_MISSED) {
 138                 view().partialUpdate(1);
 139         }
 140 }
 141
 142
 143 void ControlSpellchecker::replace(string const & replacement)
 144 {
 145         lv_.view()->replaceWord(replacement);
 146         check();
 147 }
 148
 149
 150 void ControlSpellchecker::replaceAll(string const & replacement)
 151 {
 152         // TODO: add to list
 153         replace(replacement);
 154 }
 155
 156
 157 void ControlSpellchecker::insert()
 158 {
 159         speller_->insert(word_);
 160         check();
 161 }
 162
 163
 164 string ControlSpellchecker::getSuggestion()
 165 {
 166         // this is needed because string tmp = nextmiss()
 167         // segfaults when nextMiss is 0
 168         string tmp;
 169         char const * w = speller_->nextMiss();
 170
 171         if (w!=0) {
 172                 tmp = w;
 173                 if (rtl_) std::reverse(tmp.begin(), tmp.end());
 174         }
 175
 176         return tmp;
 177 }
 178
 179
 180 string ControlSpellchecker::getWord()
 181 {
 182         string tmp = word_;
 183         if (rtl_) std::reverse(tmp.begin(), tmp.end());
 184         return tmp;
 185 }
 186
 187
 188 void ControlSpellchecker::ignoreAll()
 189 {
 190         speller_->accept(word_);
 191         check();
 192 }
 193
 194
 195 void ControlSpellchecker::stop()
 196 {
 197         stop_ = true;
 198         lv_.view()->endOfSpellCheck();
 199 }
 200
 201
 202 void ControlSpellchecker::clearParams()
 203 {
 204         if (!speller_) return;
 205
 206         if (speller_->alive()) {
 207                 speller_->close();
 208                 message_ = tostr(count_);
 209                 if (count_ != 1) {
 210                         message_ += _(" words checked.");
 211
 212                 } else {
 213                         message_ += _(" word checked.");
 214                 }
 215                 message_ = "\n" + message_;
 216                 message_ = _("Spellchecking completed! ") + message_;
 217
 218         } else {
 219                 speller_->cleanUp();
 220                 message_ = _("The spell checker has died for some reason.\n"
 221                              "Maybe it has been killed.");
 222         }
 223
 224         delete speller_;
 225
 226         lv_.view()->endOfSpellCheck();
 227
 228         // show closing message
 229         view().partialUpdate(2);
 230
 231         // reset values to initial
 232         rtl_ = false;
 233         word_ = "";
 234         newval_ = 0.0;
 235         oldval_ = 0;
 236         newvalue_ = 0;
 237         count_ = 0;
 238         message_ = "";
 239         stop_ = false;
 240         result_ = SpellBase::ISP_UNKNOWN;
 241         speller_ = 0;
 242
 243         // make sure that the dialog is not launched
 244         emergency_exit_ = true;
 245 }
 246
 247
 248 void ControlSpellchecker::options()
 249 {
 250         lv_.getDialogs()->showSpellcheckerPreferences();
 251 }