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);
86 d->ui.languageCO->setModelColumn(1);
88 d->ui.wordED->setReadOnly(true);
90 d->ui.suggestionsLW->installEventFilter(this);
94 GuiSpellchecker::~GuiSpellchecker()
100 void GuiSpellchecker::on_closePB_clicked()
106 bool GuiSpellchecker::eventFilter(QObject *obj, QEvent *event)
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();
116 } else if (e->key() == Qt::Key_Right) {
117 if (d->ui.suggestionsLW->currentItem())
118 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
122 // standard event processing
123 return QWidget::eventFilter(obj, event);
127 void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
129 if (d->ui.replaceCO->count() != 0)
130 d->ui.replaceCO->setItemText(0, item->text());
132 d->ui.replaceCO->addItem(item->text());
134 d->ui.replaceCO->setCurrentIndex(0);
138 void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
140 QListWidget * lw = d->ui.suggestionsLW;
141 if (lw->currentItem() && lw->currentItem()->text() == str)
144 for (int i = 0; i != lw->count(); ++i) {
145 if (lw->item(i)->text() == str) {
146 lw->setCurrentRow(i);
153 void GuiSpellchecker::updateView()
160 void GuiSpellchecker::forward()
162 dispatch(FuncRequest(LFUN_ESCAPE));
163 dispatch(FuncRequest(LFUN_CHAR_FORWARD));
167 void GuiSpellchecker::on_languageCO_activated(int index)
170 fromqstr(d->ui.languageCO->itemData(index).toString());
171 if (!d->word_.lang() || d->word_.lang()->lang() == lang)
174 dispatch(FuncRequest(LFUN_LANGUAGE, lang));
179 void GuiSpellchecker::on_ignoreAllPB_clicked()
181 /// replace all occurrences of word
182 if (d->word_.lang() && !d->word_.word().empty())
183 theSpellChecker()->accept(d->word_);
189 void GuiSpellchecker::on_addPB_clicked()
191 /// insert word in personal dictionary
192 theSpellChecker()->insert(d->word_);
198 void GuiSpellchecker::on_ignorePB_clicked()
205 void GuiSpellchecker::on_findNextPB_clicked()
207 docstring const data = find2string(
208 qstring_to_ucs4(d->ui.wordED->text()),
210 dispatch(FuncRequest(LFUN_WORD_FIND, data));
214 void GuiSpellchecker::on_replacePB_clicked()
216 docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
218 LYXERR(Debug::GUI, "Replace (" << replacement << ")");
220 Slight hack ahead: we want to use the dispatch machinery
221 (see bug #6217), but self-insert honors the ``auto region
222 delete'' setting, which is not wanted here. Creating a new
223 ad-hoc LFUN seems overkill, but it could be an option (JMarc).
225 bool const ard = lyxrc.auto_region_delete;
226 lyxrc.auto_region_delete = true;
227 dispatch(FuncRequest(LFUN_SELF_INSERT, replacement));
228 lyxrc.auto_region_delete = ard;
235 void GuiSpellchecker::on_replaceAllPB_clicked()
237 docstring const data = replace2string(
238 qstring_to_ucs4(d->ui.replaceCO->currentText()),
239 qstring_to_ucs4(d->ui.wordED->text()),
240 true, true, true, true);
241 dispatch(FuncRequest(LFUN_WORD_REPLACE, data));
242 check(); // continue spellchecking
246 void GuiSpellchecker::updateSuggestions(docstring_list & words)
248 QString const suggestion = toqstr(d->word_.word());
249 d->ui.wordED->setText(suggestion);
250 QListWidget * lw = d->ui.suggestionsLW;
254 on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
257 for (size_t i = 0; i != words.size(); ++i)
258 lw->addItem(toqstr(words[i]));
260 on_suggestionsLW_itemClicked(lw->item(0));
261 lw->setCurrentRow(0);
265 bool GuiSpellchecker::initialiseParams(string const &)
267 LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
269 if (!theSpellChecker())
272 DocIterator const begin = doc_iterator_begin(&buffer());
273 Cursor const & cur = bufferview()->cursor();
274 d->progress_ = countWords(begin, cur);
275 d->total_ = d->progress_ + countWords(cur, doc_iterator_end(&buffer()));
281 void GuiSpellchecker::check()
283 LYXERR(Debug::GUI, "Check the spelling of a word");
285 DocIterator from = bufferview()->cursor();
287 WordLangTuple word_lang;
288 docstring_list suggestions;
292 progress = buffer().spellCheck(from, to, word_lang, suggestions);
293 } catch (ExceptionMessage const & message) {
294 if (message.type_ == WarningException) {
295 Alert::warning(message.title_, message.details_);
301 LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
302 d->count_ += progress;
303 d->progress_ += progress;
306 if (from == doc_iterator_end(&buffer())) {
313 d->word_ = word_lang;
315 int const progress_bar = d->total_
316 ? int(100.0 * float(d->progress_)/d->total_) : 100;
317 LYXERR(Debug::GUI, "Updating spell progress.");
319 d->ui.spellcheckPR->setValue(progress_bar);
321 updateSuggestions(suggestions);
323 int const pos = d->ui.languageCO->findData(toqstr(word_lang.lang()->lang()));
325 d->ui.languageCO->setCurrentIndex(pos);
327 // FIXME: if we used a lfun like in find/replace, dispatch would do
329 int const size = to.pos() - from.pos();
330 BufferView * bv = const_cast<BufferView *>(bufferview());
331 bv->putSelectionAt(from, size, false);
335 void GuiSpellchecker::showSummary()
337 if (d->count_ == 0) {
344 message = bformat(_("%1$d words checked."), d->count_);
346 message = _("One word checked.");
349 Alert::information(_("Spelling check completed"), message);
353 Dialog * createGuiSpellchecker(GuiView & lv)
355 GuiSpellchecker * gui = new GuiSpellchecker(lv);
357 gui->setFloating(true);
363 } // namespace frontend
366 #include "moc_GuiSpellchecker.cpp"