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