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                         if (d->ui.suggestionsLW->currentItem()) {
 112                                 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
 113                                 on_replacePB_clicked();
 114                         }
 115                         return true;
 116                 } else if (e->key() == Qt::Key_Right) {
 117                         if (d->ui.suggestionsLW->currentItem())
 118                                 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
 119                         return true;
 120                 }
 121         }
 122         // standard event processing
 123         return QWidget::eventFilter(obj, event);
 124 }
 125
 126
 127 void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
 128 {
 129         if (d->ui.replaceCO->count() != 0)
 130                 d->ui.replaceCO->setItemText(0, item->text());
 131         else
 132                 d->ui.replaceCO->addItem(item->text());
 133
 134         d->ui.replaceCO->setCurrentIndex(0);
 135 }
 136
 137
 138 void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
 139 {
 140         QListWidget * lw = d->ui.suggestionsLW;
 141         if (lw->currentItem() && lw->currentItem()->text() == str)
 142                 return;
 143
 144         for (int i = 0; i != lw->count(); ++i) {
 145                 if (lw->item(i)->text() == str) {
 146                         lw->setCurrentRow(i);
 147                         break;
 148                 }
 149         }
 150 }
 151
 152
 153 void GuiSpellchecker::updateView()
 154 {
 155         if (hasFocus())
 156                 check();
 157 }
 158
 159
 160 void GuiSpellchecker::on_languageCO_activated(int index)
 161 {
 162         string const lang =
 163                 fromqstr(d->ui.languageCO->itemData(index).toString());
 164         if (!d->word_.lang() || d->word_.lang()->lang() == lang)
 165                 // nothing changed
 166                 return;
 167         dispatch(FuncRequest(LFUN_LANGUAGE, lang));
 168         check();
 169 }
 170
 171
 172 void GuiSpellchecker::on_ignoreAllPB_clicked()
 173 {
 174         /// replace all occurances of word
 175         theSpellChecker()->accept(d->word_);
 176         check();
 177 }
 178
 179
 180 void GuiSpellchecker::on_addPB_clicked()
 181 {
 182         /// insert word in personal dictionary
 183         theSpellChecker()->insert(d->word_);
 184         check();
 185 }
 186
 187
 188 void GuiSpellchecker::on_ignorePB_clicked()
 189 {
 190         dispatch(FuncRequest(LFUN_ESCAPE));
 191         dispatch(FuncRequest(LFUN_CHAR_FORWARD));
 192         check();
 193 }
 194
 195
 196 void GuiSpellchecker::on_findNextPB_clicked()
 197 {
 198         docstring const data = find2string(
 199                                 qstring_to_ucs4(d->ui.wordED->text()),
 200                                 true, true, true);
 201         dispatch(FuncRequest(LFUN_WORD_FIND, data));
 202 }
 203
 204
 205 void GuiSpellchecker::on_replacePB_clicked()
 206 {
 207         docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
 208
 209         LYXERR(Debug::GUI, "Replace (" << replacement << ")");
 210         /*
 211           Slight hack ahead: we want to use the dispatch machinery
 212           (see bug #6217), but self-insert honors the ``auto region
 213           delete'' setting, which is not wanted here. Creating a new
 214           ad-hoc LFUN seems overkill, but it could be an option (JMarc).
 215         */
 216         bool const ard = lyxrc.auto_region_delete;
 217         lyxrc.auto_region_delete = true;
 218         dispatch(FuncRequest(LFUN_SELF_INSERT, replacement));
 219         lyxrc.auto_region_delete = ard;
 220         // fix up the count
 221         --d->count_;
 222         check();
 223 }
 224
 225
 226 void GuiSpellchecker::on_replaceAllPB_clicked()
 227 {
 228         docstring const data = replace2string(
 229                 qstring_to_ucs4(d->ui.replaceCO->currentText()),
 230                 qstring_to_ucs4(d->ui.wordED->text()),
 231                 true, true, true, true);
 232         dispatch(FuncRequest(LFUN_WORD_REPLACE, data));
 233         check(); // continue spellchecking
 234 }
 235
 236
 237 void GuiSpellchecker::updateSuggestions(docstring_list & words)
 238 {
 239         QString const suggestion = toqstr(d->word_.word());
 240         d->ui.wordED->setText(suggestion);
 241         QListWidget * lw = d->ui.suggestionsLW;
 242         lw->clear();
 243
 244         if (words.empty()) {
 245                 on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
 246                 return;
 247         }
 248         for (size_t i = 0; i != words.size(); ++i)
 249                 lw->addItem(toqstr(words[i]));
 250
 251         on_suggestionsLW_itemClicked(lw->item(0));
 252         lw->setCurrentRow(0);
 253 }
 254
 255
 256 bool GuiSpellchecker::initialiseParams(string const &)
 257 {
 258         LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
 259
 260         if (!theSpellChecker())
 261                 return false;
 262
 263         DocIterator const begin = doc_iterator_begin(&buffer());
 264         Cursor const & cur = bufferview()->cursor();
 265         d->progress_ = countWords(begin, cur);
 266         d->total_ = d->progress_ + countWords(cur, doc_iterator_end(&buffer()));
 267         d->count_ = 0;
 268         return true;
 269 }
 270
 271
 272 void GuiSpellchecker::check()
 273 {
 274         LYXERR(Debug::GUI, "Check the spelling of a word");
 275
 276         DocIterator from = bufferview()->cursor();
 277         DocIterator to;
 278         WordLangTuple word_lang;
 279         docstring_list suggestions;
 280
 281         int progress;
 282         try {
 283                 progress = buffer().spellCheck(from, to, word_lang, suggestions);
 284         } catch (ExceptionMessage const & message) {
 285                 if (message.type_ == WarningException) {
 286                         Alert::warning(message.title_, message.details_);
 287                         close();
 288                         return;
 289                 }
 290                 throw message;
 291         }
 292         LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
 293         d->count_ += progress;
 294         d->progress_ += progress;
 295
 296         // end of document
 297         if (from == doc_iterator_end(&buffer())) {
 298                 showSummary();
 299                 return;
 300         }
 301         if (!isVisible())
 302                 show();
 303
 304         d->word_ = word_lang;
 305
 306         int const progress_bar = d->total_
 307                 ? int(100.0 * float(d->progress_)/d->total_) : 100;
 308         LYXERR(Debug::GUI, "Updating spell progress.");
 309         // set progress bar
 310         d->ui.spellcheckPR->setValue(progress_bar);
 311         // set suggestions
 312         updateSuggestions(suggestions);
 313         // set language
 314         int const pos = d->ui.languageCO->findData(toqstr(word_lang.lang()->lang()));
 315         if (pos != -1)
 316                 d->ui.languageCO->setCurrentIndex(pos);
 317
 318         // FIXME: if we used a lfun like in find/replace, dispatch would do
 319         // that for us
 320         int const size = to.pos() - from.pos();
 321         BufferView * bv = const_cast<BufferView *>(bufferview());
 322         bv->putSelectionAt(from, size, false);
 323 }
 324
 325
 326 void GuiSpellchecker::showSummary()
 327 {
 328         if (d->count_ == 0) {
 329                 close();
 330                 return;
 331         }
 332
 333         docstring message;
 334         if (d->count_ != 1)
 335                 message = bformat(_("%1$d words checked."), d->count_);
 336         else
 337                 message = _("One word checked.");
 338
 339         close();
 340         Alert::information(_("Spelling check completed"), message);
 341 }
 342
 343
 344 Dialog * createGuiSpellchecker(GuiView & lv)
 345 {
 346         GuiSpellchecker * gui = new GuiSpellchecker(lv);
 347 #ifdef Q_WS_MACX
 348         gui->setFloating(true);
 349 #endif
 350         return gui;
 351 }
 352
 353
 354 } // namespace frontend
 355 } // namespace lyx
 356
 357 #include "moc_GuiSpellchecker.cpp"