2 * \file GuiSpellchecker.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
15 #include "GuiSpellchecker.h"
16 #include "GuiApplication.h"
18 #include "qt_helpers.h"
20 #include "ui_SpellcheckerUi.h"
23 #include "BufferParams.h"
24 #include "BufferView.h"
25 #include "buffer_funcs.h"
27 #include "CutAndPaste.h"
28 #include "FuncRequest.h"
33 #include "Paragraph.h"
34 #include "WordLangTuple.h"
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"
44 #include <QListWidgetItem>
47 #include "SpellChecker.h"
49 #include "frontends/alert.h"
52 using namespace lyx::support;
58 struct GuiSpellchecker::Private
60 Private() : progress_(0), count_(0) {}
61 Ui::SpellcheckerUi ui;
62 /// current word being checked and lang code
64 /// values for progress
72 GuiSpellchecker::GuiSpellchecker(GuiView & lv)
73 : DockView(lv, "spellchecker", qt_("Spellchecker"),
74 Qt::RightDockWidgetArea), d(new GuiSpellchecker::Private)
78 connect(d->ui.suggestionsLW, SIGNAL(itemDoubleClicked(QListWidgetItem*)),
79 this, SLOT(on_replacePB_clicked()));
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);
87 d->ui.wordED->setReadOnly(true);
89 d->ui.suggestionsLW->installEventFilter(this);
93 GuiSpellchecker::~GuiSpellchecker()
99 void GuiSpellchecker::on_closePB_clicked()
105 bool GuiSpellchecker::eventFilter(QObject *obj, QEvent *event)
107 if (obj == d->ui.suggestionsLW && event->type() == QEvent::KeyPress) {
108 QKeyEvent *e = static_cast<QKeyEvent *> (event);
109 if (e->key() == Qt::Key_Enter || e->key() == Qt::Key_Return) {
110 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
111 on_replacePB_clicked();
113 } else if (e->key() == Qt::Key_Right) {
114 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
118 // standard event processing
119 return QWidget::eventFilter(obj, event);
123 void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
125 if (d->ui.replaceCO->count() != 0)
126 d->ui.replaceCO->setItemText(0, item->text());
128 d->ui.replaceCO->addItem(item->text());
130 d->ui.replaceCO->setCurrentIndex(0);
134 void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
136 QListWidget * lw = d->ui.suggestionsLW;
137 if (lw->currentItem() && lw->currentItem()->text() == str)
140 for (int i = 0; i != lw->count(); ++i) {
141 if (lw->item(i)->text() == str) {
142 lw->setCurrentRow(i);
149 void GuiSpellchecker::updateView()
156 void GuiSpellchecker::on_languageCO_activated(int index)
159 fromqstr(d->ui.languageCO->itemData(index).toString());
160 if (d->word_.lang()->lang() == lang)
163 dispatch(FuncRequest(LFUN_LANGUAGE, lang));
168 void GuiSpellchecker::on_ignoreAllPB_clicked()
170 /// replace all occurances of word
171 theSpellChecker()->accept(d->word_);
176 void GuiSpellchecker::on_addPB_clicked()
178 /// insert word in personal dictionary
179 theSpellChecker()->insert(d->word_);
184 void GuiSpellchecker::on_ignorePB_clicked()
186 dispatch(FuncRequest(LFUN_ESCAPE));
187 dispatch(FuncRequest(LFUN_CHAR_FORWARD));
192 void GuiSpellchecker::on_findNextPB_clicked()
194 docstring const data = find2string(
195 qstring_to_ucs4(d->ui.wordED->text()),
197 dispatch(FuncRequest(LFUN_WORD_FIND, data));
201 void GuiSpellchecker::on_replacePB_clicked()
203 docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
205 LYXERR(Debug::GUI, "Replace (" << replacement << ")");
206 BufferView * bv = const_cast<BufferView *>(bufferview());
207 if (!bv->cursor().inTexted())
209 cap::replaceSelectionWithString(bv->cursor(), replacement, true);
210 bv->buffer().markDirty();
211 // If we used an LFUN, we would not need that
212 bv->processUpdateFlags(Update::Force | Update::FitCursor);
219 void GuiSpellchecker::on_replaceAllPB_clicked()
221 docstring const data = replace2string(
222 qstring_to_ucs4(d->ui.replaceCO->currentText()),
223 qstring_to_ucs4(d->ui.wordED->text()),
224 true, true, true, true);
225 dispatch(FuncRequest(LFUN_WORD_REPLACE, data));
226 check(); // continue spellchecking
230 void GuiSpellchecker::updateSuggestions(docstring_list & words)
232 QString const suggestion = toqstr(d->word_.word());
233 d->ui.wordED->setText(suggestion);
234 QListWidget * lw = d->ui.suggestionsLW;
238 on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
241 for (size_t i = 0; i != words.size(); ++i)
242 lw->addItem(toqstr(words[i]));
244 on_suggestionsLW_itemClicked(lw->item(0));
245 lw->setCurrentRow(0);
249 bool GuiSpellchecker::initialiseParams(string const &)
251 LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
253 if (!theSpellChecker())
256 DocIterator const begin = doc_iterator_begin(&buffer());
257 Cursor const & cur = bufferview()->cursor();
258 d->progress_ = countWords(begin, cur);
259 d->total_ = d->progress_ + countWords(cur, doc_iterator_end(&buffer()));
265 void GuiSpellchecker::check()
267 LYXERR(Debug::GUI, "Check the spelling of a word");
269 DocIterator from = bufferview()->cursor();
271 WordLangTuple word_lang;
272 docstring_list suggestions;
276 progress = buffer().spellCheck(from, to, word_lang, suggestions);
277 } catch (ExceptionMessage const & message) {
278 if (message.type_ == WarningException) {
279 Alert::warning(message.title_, message.details_);
285 LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
286 d->count_ += progress;
287 d->progress_ += progress;
290 if (from == doc_iterator_end(&buffer())) {
297 d->word_ = word_lang;
299 int const progress_bar = d->total_
300 ? int(100.0 * float(d->progress_)/d->total_) : 100;
301 LYXERR(Debug::GUI, "Updating spell progress.");
303 d->ui.spellcheckPR->setValue(progress_bar);
305 updateSuggestions(suggestions);
307 int const pos = d->ui.languageCO->findData(toqstr(word_lang.lang()->lang()));
309 d->ui.languageCO->setCurrentIndex(pos);
311 // FIXME: if we used a lfun like in find/replace, dispatch would do
313 int const size = to.pos() - from.pos();
314 BufferView * bv = const_cast<BufferView *>(bufferview());
315 bv->putSelectionAt(from, size, false);
319 void GuiSpellchecker::showSummary()
321 if (d->count_ == 0) {
328 message = bformat(_("%1$d words checked."), d->count_);
330 message = _("One word checked.");
333 Alert::information(_("Spelling check completed"), message);
337 Dialog * createGuiSpellchecker(GuiView & lv) { return new GuiSpellchecker(lv); }
339 } // namespace frontend
342 #include "moc_GuiSpellchecker.cpp"