src/frontends/qt4/GuiSpellchecker.cpp

   1 /**
   2  * \file GuiSpellchecker.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Edwin Leuven
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "GuiSpellchecker.h"
  16 #include "GuiApplication.h"
  17
  18 #include "qt_helpers.h"
  19
  20 #include "ui_SpellcheckerUi.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "buffer_funcs.h"
  26 #include "Cursor.h"
  27 #include "CutAndPaste.h"
  28 #include "FuncRequest.h"
  29 #include "Language.h"
  30 #include "LyX.h"
  31 #include "LyXRC.h"
  32 #include "lyxfind.h"
  33 #include "Paragraph.h"
  34 #include "WordLangTuple.h"
  35
  36 #include "support/debug.h"
  37 #include "support/docstring.h"
  38 #include "support/docstring_list.h"
  39 #include "support/ExceptionMessage.h"
  40 #include "support/gettext.h"
  41 #include "support/lstrings.h"
  42 #include "support/textutils.h"
  43
  44 #include <QListWidgetItem>
  45 #include <QKeyEvent>
  46
  47 #include "SpellChecker.h"
  48
  49 #include "frontends/alert.h"
  50
  51 using namespace std;
  52 using namespace lyx::support;
  53
  54 namespace lyx {
  55 namespace frontend {
  56
  57
  58 struct GuiSpellchecker::Private
  59 {
  60         Private() : progress_(0), count_(0) {}
  61         Ui::SpellcheckerUi ui;
  62         /// current word being checked and lang code
  63         WordLangTuple word_;
  64         /// values for progress
  65         int total_;
  66         int progress_;
  67         /// word count
  68         int count_;
  69 };
  70
  71
  72 GuiSpellchecker::GuiSpellchecker(GuiView & lv)
  73         : DockView(lv, "spellchecker", qt_("Spellchecker"),
  74         Qt::RightDockWidgetArea), d(new GuiSpellchecker::Private)
  75 {
  76         d->ui.setupUi(this);
  77
  78         connect(d->ui.suggestionsLW, SIGNAL(itemDoubleClicked(QListWidgetItem*)),
  79                 this, SLOT(on_replacePB_clicked()));
  80
  81         // language
  82         QAbstractItemModel * language_model = guiApp->languageModel();
  83         // FIXME: it would be nice if sorting was enabled/disabled via a checkbox.
  84         language_model->sort(0);
  85         d->ui.languageCO->setModel(language_model);
  86         d->ui.languageCO->setModelColumn(1);
  87
  88         d->ui.wordED->setReadOnly(true);
  89
  90         d->ui.suggestionsLW->installEventFilter(this);
  91 }
  92
  93
  94 GuiSpellchecker::~GuiSpellchecker()
  95 {
  96         delete d;
  97 }
  98
  99
 100 void GuiSpellchecker::on_closePB_clicked()
 101 {
 102         close();
 103 }
 104
 105
 106 bool GuiSpellchecker::eventFilter(QObject *obj, QEvent *event)
 107 {
 108         if (obj == d->ui.suggestionsLW && event->type() == QEvent::KeyPress) {
 109                 QKeyEvent *e = static_cast<QKeyEvent *> (event);
 110                 if (e->key() == Qt::Key_Enter || e->key() == Qt::Key_Return) {
 111                         on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
 112                         on_replacePB_clicked();
 113                         return true;
 114                 } else if (e->key() == Qt::Key_Right) {
 115                         on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
 116                         return true;
 117                 }
 118         }
 119         // standard event processing
 120         return QWidget::eventFilter(obj, event);
 121 }
 122
 123
 124 void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
 125 {
 126         if (d->ui.replaceCO->count() != 0)
 127                 d->ui.replaceCO->setItemText(0, item->text());
 128         else
 129                 d->ui.replaceCO->addItem(item->text());
 130
 131         d->ui.replaceCO->setCurrentIndex(0);
 132 }
 133
 134
 135 void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
 136 {
 137         QListWidget * lw = d->ui.suggestionsLW;
 138         if (lw->currentItem() && lw->currentItem()->text() == str)
 139                 return;
 140
 141         for (int i = 0; i != lw->count(); ++i) {
 142                 if (lw->item(i)->text() == str) {
 143                         lw->setCurrentRow(i);
 144                         break;
 145                 }
 146         }
 147 }
 148
 149
 150 void GuiSpellchecker::updateView()
 151 {
 152         if (hasFocus())
 153                 check();
 154 }
 155
 156
 157 void GuiSpellchecker::on_languageCO_activated(int index)
 158 {
 159         string const lang =
 160                 fromqstr(d->ui.languageCO->itemData(index).toString());
 161         if (!d->word_.lang() || d->word_.lang()->lang() == lang)
 162                 // nothing changed
 163                 return;
 164         dispatch(FuncRequest(LFUN_LANGUAGE, lang));
 165         check();
 166 }
 167
 168
 169 void GuiSpellchecker::on_ignoreAllPB_clicked()
 170 {
 171         /// replace all occurances of word
 172         theSpellChecker()->accept(d->word_);
 173         check();
 174 }
 175
 176
 177 void GuiSpellchecker::on_addPB_clicked()
 178 {
 179         /// insert word in personal dictionary
 180         theSpellChecker()->insert(d->word_);
 181         check();
 182 }
 183
 184
 185 void GuiSpellchecker::on_ignorePB_clicked()
 186 {
 187         dispatch(FuncRequest(LFUN_ESCAPE));
 188         dispatch(FuncRequest(LFUN_CHAR_FORWARD));
 189         check();
 190 }
 191
 192
 193 void GuiSpellchecker::on_findNextPB_clicked()
 194 {
 195         docstring const data = find2string(
 196                                 qstring_to_ucs4(d->ui.wordED->text()),
 197                                 true, true, true);
 198         dispatch(FuncRequest(LFUN_WORD_FIND, data));
 199 }
 200
 201
 202 void GuiSpellchecker::on_replacePB_clicked()
 203 {
 204         docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
 205
 206         LYXERR(Debug::GUI, "Replace (" << replacement << ")");
 207         /*
 208           Slight hack ahead: we want to use the dispatch machinery
 209           (see bug #6217), but self-insert honors the ``auto region
 210           delete'' setting, which is not wanted here. Creating a new
 211           ad-hoc LFUN seems overkill, but it could be an option (JMarc).
 212         */
 213         bool const ard = lyxrc.auto_region_delete;
 214         lyxrc.auto_region_delete = true;
 215         dispatch(FuncRequest(LFUN_SELF_INSERT, replacement));
 216         lyxrc.auto_region_delete = ard;
 217         // fix up the count
 218         --d->count_;
 219         check();
 220 }
 221
 222
 223 void GuiSpellchecker::on_replaceAllPB_clicked()
 224 {
 225         docstring const data = replace2string(
 226                 qstring_to_ucs4(d->ui.replaceCO->currentText()),
 227                 qstring_to_ucs4(d->ui.wordED->text()),
 228                 true, true, true, true);
 229         dispatch(FuncRequest(LFUN_WORD_REPLACE, data));
 230         check(); // continue spellchecking
 231 }
 232
 233
 234 void GuiSpellchecker::updateSuggestions(docstring_list & words)
 235 {
 236         QString const suggestion = toqstr(d->word_.word());
 237         d->ui.wordED->setText(suggestion);
 238         QListWidget * lw = d->ui.suggestionsLW;
 239         lw->clear();
 240
 241         if (words.empty()) {
 242                 on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
 243                 return;
 244         }
 245         for (size_t i = 0; i != words.size(); ++i)
 246                 lw->addItem(toqstr(words[i]));
 247
 248         on_suggestionsLW_itemClicked(lw->item(0));
 249         lw->setCurrentRow(0);
 250 }
 251
 252
 253 bool GuiSpellchecker::initialiseParams(string const &)
 254 {
 255         LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
 256
 257         if (!theSpellChecker())
 258                 return false;
 259
 260         DocIterator const begin = doc_iterator_begin(&buffer());
 261         Cursor const & cur = bufferview()->cursor();
 262         d->progress_ = countWords(begin, cur);
 263         d->total_ = d->progress_ + countWords(cur, doc_iterator_end(&buffer()));
 264         d->count_ = 0;
 265         return true;
 266 }
 267
 268
 269 void GuiSpellchecker::check()
 270 {
 271         LYXERR(Debug::GUI, "Check the spelling of a word");
 272
 273         DocIterator from = bufferview()->cursor();
 274         DocIterator to;
 275         WordLangTuple word_lang;
 276         docstring_list suggestions;
 277
 278         int progress;
 279         try {
 280                 progress = buffer().spellCheck(from, to, word_lang, suggestions);
 281         } catch (ExceptionMessage const & message) {
 282                 if (message.type_ == WarningException) {
 283                         Alert::warning(message.title_, message.details_);
 284                         close();
 285                         return;
 286                 }
 287                 throw message;
 288         }
 289         LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
 290         d->count_ += progress;
 291         d->progress_ += progress;
 292
 293         // end of document
 294         if (from == doc_iterator_end(&buffer())) {
 295                 showSummary();
 296                 return;
 297         }
 298         if (!isVisible())
 299                 show();
 300
 301         d->word_ = word_lang;
 302
 303         int const progress_bar = d->total_
 304                 ? int(100.0 * float(d->progress_)/d->total_) : 100;
 305         LYXERR(Debug::GUI, "Updating spell progress.");
 306         // set progress bar
 307         d->ui.spellcheckPR->setValue(progress_bar);
 308         // set suggestions
 309         updateSuggestions(suggestions);
 310         // set language
 311         int const pos = d->ui.languageCO->findData(toqstr(word_lang.lang()->lang()));
 312         if (pos != -1)
 313                 d->ui.languageCO->setCurrentIndex(pos);
 314
 315         // FIXME: if we used a lfun like in find/replace, dispatch would do
 316         // that for us
 317         int const size = to.pos() - from.pos();
 318         BufferView * bv = const_cast<BufferView *>(bufferview());
 319         bv->putSelectionAt(from, size, false);
 320 }
 321
 322
 323 void GuiSpellchecker::showSummary()
 324 {
 325         if (d->count_ == 0) {
 326                 close();
 327                 return;
 328         }
 329
 330         docstring message;
 331         if (d->count_ != 1)
 332                 message = bformat(_("%1$d words checked."), d->count_);
 333         else
 334                 message = _("One word checked.");
 335
 336         close();
 337         Alert::information(_("Spelling check completed"), message);
 338 }
 339
 340
 341 Dialog * createGuiSpellchecker(GuiView & lv)
 342 {
 343         GuiSpellchecker * gui = new GuiSpellchecker(lv);
 344 #ifdef Q_WS_MACX
 345         gui->setFloating(true);
 346 #endif
 347         return gui;
 348 }
 349
 350
 351 } // namespace frontend
 352 } // namespace lyx
 353
 354 #include "moc_GuiSpellchecker.cpp"