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 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
112 on_replacePB_clicked();
114 } else if (e->key() == Qt::Key_Right) {
115 on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
119 // standard event processing
120 return QWidget::eventFilter(obj, event);
124 void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
126 if (d->ui.replaceCO->count() != 0)
127 d->ui.replaceCO->setItemText(0, item->text());
129 d->ui.replaceCO->addItem(item->text());
131 d->ui.replaceCO->setCurrentIndex(0);
135 void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
137 QListWidget * lw = d->ui.suggestionsLW;
138 if (lw->currentItem() && lw->currentItem()->text() == str)
141 for (int i = 0; i != lw->count(); ++i) {
142 if (lw->item(i)->text() == str) {
143 lw->setCurrentRow(i);
150 void GuiSpellchecker::updateView()
157 void GuiSpellchecker::on_languageCO_activated(int index)
160 fromqstr(d->ui.languageCO->itemData(index).toString());
161 if (!d->word_.lang() || d->word_.lang()->lang() == lang)
164 dispatch(FuncRequest(LFUN_LANGUAGE, lang));
169 void GuiSpellchecker::on_ignoreAllPB_clicked()
171 /// replace all occurances of word
172 theSpellChecker()->accept(d->word_);
177 void GuiSpellchecker::on_addPB_clicked()
179 /// insert word in personal dictionary
180 theSpellChecker()->insert(d->word_);
185 void GuiSpellchecker::on_ignorePB_clicked()
187 dispatch(FuncRequest(LFUN_ESCAPE));
188 dispatch(FuncRequest(LFUN_CHAR_FORWARD));
193 void GuiSpellchecker::on_findNextPB_clicked()
195 docstring const data = find2string(
196 qstring_to_ucs4(d->ui.wordED->text()),
198 dispatch(FuncRequest(LFUN_WORD_FIND, data));
202 void GuiSpellchecker::on_replacePB_clicked()
204 docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
206 LYXERR(Debug::GUI, "Replace (" << replacement << ")");
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).
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;
223 void GuiSpellchecker::on_replaceAllPB_clicked()
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
234 void GuiSpellchecker::updateSuggestions(docstring_list & words)
236 QString const suggestion = toqstr(d->word_.word());
237 d->ui.wordED->setText(suggestion);
238 QListWidget * lw = d->ui.suggestionsLW;
242 on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
245 for (size_t i = 0; i != words.size(); ++i)
246 lw->addItem(toqstr(words[i]));
248 on_suggestionsLW_itemClicked(lw->item(0));
249 lw->setCurrentRow(0);
253 bool GuiSpellchecker::initialiseParams(string const &)
255 LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
257 if (!theSpellChecker())
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()));
269 void GuiSpellchecker::check()
271 LYXERR(Debug::GUI, "Check the spelling of a word");
273 DocIterator from = bufferview()->cursor();
275 WordLangTuple word_lang;
276 docstring_list suggestions;
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_);
289 LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
290 d->count_ += progress;
291 d->progress_ += progress;
294 if (from == doc_iterator_end(&buffer())) {
301 d->word_ = word_lang;
303 int const progress_bar = d->total_
304 ? int(100.0 * float(d->progress_)/d->total_) : 100;
305 LYXERR(Debug::GUI, "Updating spell progress.");
307 d->ui.spellcheckPR->setValue(progress_bar);
309 updateSuggestions(suggestions);
311 int const pos = d->ui.languageCO->findData(toqstr(word_lang.lang()->lang()));
313 d->ui.languageCO->setCurrentIndex(pos);
315 // FIXME: if we used a lfun like in find/replace, dispatch would do
317 int const size = to.pos() - from.pos();
318 BufferView * bv = const_cast<BufferView *>(bufferview());
319 bv->putSelectionAt(from, size, false);
323 void GuiSpellchecker::showSummary()
325 if (d->count_ == 0) {
332 message = bformat(_("%1$d words checked."), d->count_);
334 message = _("One word checked.");
337 Alert::information(_("Spelling check completed"), message);
341 Dialog * createGuiSpellchecker(GuiView & lv) { return new GuiSpellchecker(lv); }
343 } // namespace frontend
346 #include "moc_GuiSpellchecker.cpp"