]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiSpellchecker.cpp
* fix spelling in comments to please John.
[lyx.git] / src / frontends / qt4 / GuiSpellchecker.cpp
index 027b397ed4d09e4951ea48c8fd7194a48bf4d3af..10edda44629b9b24705a5ed14d0113403dce9b3c 100644 (file)
@@ -4,6 +4,8 @@
  * Licence details can be found in the file COPYING.
  *
  * \author John Levon
+ * \author Edwin Leuven
+ * \author Abdelrazak Younes
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "GuiSpellchecker.h"
 
-#include "ControlSpellchecker.h"
 #include "qt_helpers.h"
 
-#include <QProgressBar>
-#include <QLineEdit>
-#include <QPushButton>
-#include <QListWidget>
+#include "ui_SpellcheckerUi.h"
+
+#include "Buffer.h"
+#include "BufferParams.h"
+#include "BufferView.h"
+#include "buffer_funcs.h"
+#include "Cursor.h"
+#include "CutAndPaste.h"
+#include "FuncRequest.h"
+#include "Language.h"
+#include "LyX.h"
+#include "LyXRC.h"
+#include "lyxfind.h"
+#include "Paragraph.h"
+#include "WordLangTuple.h"
+
+#include "support/debug.h"
+#include "support/docstring.h"
+#include "support/docstring_list.h"
+#include "support/ExceptionMessage.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+#include "support/textutils.h"
+
 #include <QListWidgetItem>
-#include <QCloseEvent>
-#include <QSyntaxHighlighter>
-#include <QTextCharFormat>
-#include <QTextDocument>
+#include <QKeyEvent>
+
+#include "SpellChecker.h"
 
+#include "frontends/alert.h"
 
-using std::string;
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 namespace frontend {
 
-GuiSpellcheckerDialog::GuiSpellcheckerDialog(LyXView & lv)
-       : GuiDialog(lv, "spellchecker")
-{
-       setupUi(this);
-       setViewTitle(_("Spellchecker"));
-       setController(new ControlSpellchecker(*this));
-
-       connect(closePB, SIGNAL(clicked()), this, SLOT(slotClose()));
-
-       connect(replaceCO, SIGNAL(highlighted(const QString &)),
-               this, SLOT(replaceChanged(const QString &)));
-       connect(replacePB, SIGNAL(clicked()),
-               this, SLOT(replaceClicked()));
-       connect(ignorePB, SIGNAL(clicked()),
-               this, SLOT(ignoreClicked()));
-       connect(replacePB_3, SIGNAL(clicked()),
-               this, SLOT(acceptClicked()));
-       connect(addPB, SIGNAL(clicked()),
-               this, SLOT(addClicked()));
-       connect(suggestionsLW, SIGNAL(itemDoubleClicked(QListWidgetItem*)),
-               this, SLOT(replaceClicked() ) );
-       connect(suggestionsLW, SIGNAL(itemClicked(QListWidgetItem*)),
-               this, SLOT(suggestionChanged(QListWidgetItem*)));
-
-       wordED->setReadOnly(true);
 
-       bc().setPolicy(ButtonPolicy::NoRepeatedApplyReadOnlyPolicy);
-       bc().setCancel(closePB);
-}
-
-
-ControlSpellchecker & GuiSpellcheckerDialog::controller() const
+struct GuiSpellchecker::Private
 {
-       return static_cast<ControlSpellchecker &>(GuiDialog::controller());
-}
+       Private() : progress_(0), count_(0) {}
+       Ui::SpellcheckerUi ui;
+       /// current word being checked and lang code
+       WordLangTuple word_;
+       /// values for progress
+       int total_;
+       int progress_;
+       /// word count
+       int count_;
+};
+
+
+GuiSpellchecker::GuiSpellchecker(GuiView & lv)
+       : DockView(lv, "spellchecker", qt_("Spellchecker"),
+       Qt::RightDockWidgetArea), d(new GuiSpellchecker::Private)
+{
+       d->ui.setupUi(this);
 
+       connect(d->ui.suggestionsLW, SIGNAL(itemDoubleClicked(QListWidgetItem*)),
+               this, SLOT(on_replacePB_clicked()));
 
-void GuiSpellcheckerDialog::acceptClicked()
-{
-       accept();
+       d->ui.wordED->setReadOnly(true);
+
+       d->ui.suggestionsLW->installEventFilter(this);
 }
 
 
-void GuiSpellcheckerDialog::addClicked()
+GuiSpellchecker::~GuiSpellchecker()
 {
-       add();
+       delete d;
 }
 
 
-void GuiSpellcheckerDialog::replaceClicked()
+void GuiSpellchecker::on_closePB_clicked()
 {
-       replace();
+       close();
 }
 
 
-void GuiSpellcheckerDialog::ignoreClicked()
+bool GuiSpellchecker::eventFilter(QObject *obj, QEvent *event)
 {
-       ignore();
+       if (obj == d->ui.suggestionsLW && event->type() == QEvent::KeyPress) {
+               QKeyEvent *e = static_cast<QKeyEvent *> (event);
+               if (e->key() == Qt::Key_Enter || e->key() == Qt::Key_Return) {
+                       on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
+                       on_replacePB_clicked();
+                       return true;
+               } else if (e->key() == Qt::Key_Right) {
+                       on_suggestionsLW_itemClicked(d->ui.suggestionsLW->currentItem());
+                       return true;
+               }
+       }
+       // standard event processing
+       return QWidget::eventFilter(obj, event);
 }
 
 
-void GuiSpellcheckerDialog::suggestionChanged(QListWidgetItem * item)
+void GuiSpellchecker::on_suggestionsLW_itemClicked(QListWidgetItem * item)
 {
-       if (replaceCO->count() != 0)
-               replaceCO->setItemText(0, item->text());
+       if (d->ui.replaceCO->count() != 0)
+               d->ui.replaceCO->setItemText(0, item->text());
        else
-               replaceCO->addItem(item->text());
+               d->ui.replaceCO->addItem(item->text());
 
-       replaceCO->setCurrentIndex(0);
+       d->ui.replaceCO->setCurrentIndex(0);
 }
 
 
-void GuiSpellcheckerDialog::replaceChanged(const QString & str)
+void GuiSpellchecker::on_replaceCO_highlighted(const QString & str)
 {
-       if (suggestionsLW->currentItem()->text() == str)
+       QListWidget * lw = d->ui.suggestionsLW;
+       if (lw->currentItem() && lw->currentItem()->text() == str)
                return;
 
-       for (int i = 0; i < suggestionsLW->count(); ++i) {
-               if (suggestionsLW->item(i)->text() == str) {
-                       suggestionsLW->setCurrentRow(i);
+       for (int i = 0; i != lw->count(); ++i) {
+               if (lw->item(i)->text() == str) {
+                       lw->setCurrentRow(i);
                        break;
                }
        }
 }
 
 
-void GuiSpellcheckerDialog::closeEvent(QCloseEvent * e)
+void GuiSpellchecker::updateView()
 {
-       slotClose();
-       e->accept();
+       if (hasFocus())
+               check();
 }
 
 
-void GuiSpellcheckerDialog::reject()
+void GuiSpellchecker::on_ignoreAllPB_clicked()
 {
-       slotClose();
-       QDialog::reject();
+       /// replace all occurances of word
+       theSpellChecker()->accept(d->word_);
+       check();
 }
 
 
-void GuiSpellcheckerDialog::update_contents()
+void GuiSpellchecker::on_addPB_clicked()
 {
-       if (isVisibleView() || controller().exitEarly())
-               controller().check();
+       /// insert word in personal dictionary
+       theSpellChecker()->insert(d->word_);
+       check();
 }
 
 
-void GuiSpellcheckerDialog::accept()
+void GuiSpellchecker::on_ignorePB_clicked()
 {
-       controller().ignoreAll();
+       dispatch(FuncRequest(LFUN_CHAR_FORWARD));
+       check();
 }
 
 
-void GuiSpellcheckerDialog::add()
+void GuiSpellchecker::on_findNextPB_clicked()
 {
-       controller().insert();
+       docstring const data = find2string(
+                               qstring_to_ucs4(d->ui.wordED->text()),
+                               true, true, true);
+       dispatch(FuncRequest(LFUN_WORD_FIND, data));
 }
 
 
-void GuiSpellcheckerDialog::ignore()
+void GuiSpellchecker::on_replacePB_clicked()
 {
-       controller().check();
+       docstring const replacement = qstring_to_ucs4(d->ui.replaceCO->currentText());
+
+       LYXERR(Debug::GUI, "Replace (" << replacement << ")");
+       BufferView * bv = const_cast<BufferView *>(bufferview());
+       if (!bv->cursor().inTexted())
+               return;
+       cap::replaceSelectionWithString(bv->cursor(), replacement, true);
+       bv->buffer().markDirty();
+       // If we used an LFUN, we would not need that
+       bv->processUpdateFlags(Update::Force | Update::FitCursor);
+       // fix up the count
+       --d->count_;
+       check();
 }
 
 
-void GuiSpellcheckerDialog::replace()
+void GuiSpellchecker::on_replaceAllPB_clicked()
 {
-       controller().replace(qstring_to_ucs4(replaceCO->currentText()));
+       docstring const data = replace2string(
+               qstring_to_ucs4(d->ui.replaceCO->currentText()),
+               qstring_to_ucs4(d->ui.wordED->text()),
+               true, true, true, true);
+       dispatch(FuncRequest(LFUN_WORD_REPLACE, data));
+       check(); // continue spellchecking
 }
 
 
-void GuiSpellcheckerDialog::partialUpdate(int state)
+void GuiSpellchecker::updateSuggestions(docstring_list & words)
 {
-       switch (state) {
-               case ControlSpellchecker::SPELL_PROGRESSED:
-                       spellcheckPR->setValue(controller().getProgress());
-                       break;
+       QString const suggestion = toqstr(d->word_.word());
+       d->ui.wordED->setText(suggestion);
+       QListWidget * lw = d->ui.suggestionsLW;
+       lw->clear();
 
-               case ControlSpellchecker::SPELL_FOUND_WORD: {
-                       wordED->setText(toqstr(controller().getWord()));
-                       suggestionsLW->clear();
+       if (words.empty()) {
+               on_suggestionsLW_itemClicked(new QListWidgetItem(suggestion));
+               return;
+       }
+       for (size_t i = 0; i != words.size(); ++i)
+               lw->addItem(toqstr(words[i]));
 
-                       docstring w;
-                       while (!(w = controller().getSuggestion()).empty())
-                               suggestionsLW->addItem(toqstr(w));
+       on_suggestionsLW_itemClicked(lw->item(0));
+       lw->setCurrentRow(0);
+}
 
-                       if (suggestionsLW->count() == 0)
-                               suggestionChanged(new QListWidgetItem(wordED->text()));
-                       else
-                               suggestionChanged(suggestionsLW->item(0));
 
-                       suggestionsLW->setCurrentRow(0);
-                       break;
+bool GuiSpellchecker::initialiseParams(string const &)
+{
+       LYXERR(Debug::GUI, "Spellchecker::initialiseParams");
+
+       if (!theSpellChecker())
+               return false;
+
+       DocIterator const begin = doc_iterator_begin(&buffer());
+       Cursor const & cur = bufferview()->cursor();
+       d->progress_ = countWords(begin, cur);
+       d->total_ = d->progress_ + countWords(cur, doc_iterator_end(&buffer()));
+       d->count_ = 0;
+       return true;
+}
+
+
+void GuiSpellchecker::check()
+{
+       LYXERR(Debug::GUI, "Check the spelling of a word");
+
+       DocIterator from = bufferview()->cursor();
+       DocIterator to;
+       WordLangTuple word_lang;
+       docstring_list suggestions;
+
+       int progress;
+       try {
+               progress = buffer().spellCheck(from, to, word_lang, suggestions);
+       } catch (ExceptionMessage const & message) {
+               if (message.type_ == WarningException) {
+                       Alert::warning(message.title_, message.details_);
+                       close();
+                       return;
                }
+               throw message;
        }
+       LYXERR(Debug::GUI, "Found word \"" << word_lang.word() << "\"");
+       d->count_ += progress;
+       d->progress_ += progress;
+
+       // end of document
+       if (from == doc_iterator_end(&buffer())) {
+               showSummary();
+               return;
+       }
+       if (!isVisible())
+               show();
+
+       d->word_ = word_lang;
+
+       int const progress_bar = d->total_
+               ? int(100.0 * float(d->progress_)/d->total_) : 100;
+       LYXERR(Debug::GUI, "Updating spell progress.");
+       // set progress bar
+       d->ui.spellcheckPR->setValue(progress_bar);
+       // set suggestions
+       updateSuggestions(suggestions);
+
+       // FIXME: if we used a lfun like in find/replace, dispatch would do
+       // that for us
+       int const size = to.pos() - from.pos();
+       BufferView * bv = const_cast<BufferView *>(bufferview());
+       bv->putSelectionAt(from, size, false);
 }
 
+
+void GuiSpellchecker::showSummary()
+{
+       if (d->count_ == 0) {
+               close();
+               return;
+       }
+
+       docstring message;
+       if (d->count_ != 1)
+               message = bformat(_("%1$d words checked."), d->count_);
+       else
+               message = _("One word checked.");
+
+       close();
+       Alert::information(_("Spelling check completed"), message);
+}
+
+
+Dialog * createGuiSpellchecker(GuiView & lv) { return new GuiSpellchecker(lv); }
+
 } // namespace frontend
 } // namespace lyx
 
-#include "GuiSpellchecker_moc.cpp"
+#include "moc_GuiSpellchecker.cpp"