File indexing completed on 2023-05-30 10:39:36

 /***************************************************************************
  *   Copyright (C) 2002 by Gunnar Schmi Dt <kmouth@schmi-dt.de             *
  *             (C) 2015 by Jeremy Whiting <jpwhiting@kde.org>              *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.          *
  ***************************************************************************/
 
 // application specific includes
 #include "phraselist.h"
 
 // include files for Qt
 #include <QApplication>
 #include <QClipboard>
 #include <QFileDialog>
 #include <QHBoxLayout>
 #include <QKeyEvent>
 #include <QListView>
 #include <QPushButton>
 #include <QStandardItem>
 #include <QVBoxLayout>
 
 // include files for KDE
 #include <KComboBox>
 #include <KConfigGroup>
 #include <QIcon>
 #include <KLineEdit>
 #include <KLocalizedString>
 #include <KMessageBox>
 #include <KXMLGUIFactory>
 
 #include "kmouth.h"
 #include "texttospeechsystem.h"
 #include "phrasebook/phrasebook.h"
 #include "wordcompletion/wordcompletion.h"
 
 PhraseList::PhraseList(QWidget *parent, const QString &name) : QWidget(parent)
 {
     Q_UNUSED(name);
     isInSlot = false;
     // FIXME: Remove or change PaletteBase to Qt::OpaqueMode?
     // setBackgroundMode(PaletteBase);
     QVBoxLayout *layout = new QVBoxLayout(this);
 
     m_listView = new QListView(this);
     m_model = new QStandardItemModel(this);
     m_listView->setModel(m_model);
     m_listView->setFocusPolicy(Qt::NoFocus);
     m_listView->setSelectionMode(QAbstractItemView::ExtendedSelection);
     m_listView->setWhatsThis(i18n("This list contains the history of spoken sentences. You can select sentences and press the speak button for re-speaking."));
     layout->addWidget(m_listView);
 
     QHBoxLayout *rowLayout = new QHBoxLayout();
     layout->addLayout(rowLayout);
 
     completion = new WordCompletion();
 
     dictionaryCombo = new KComboBox(this);
     configureCompletionCombo(completion->wordLists());
     rowLayout->addWidget(dictionaryCombo);
 
     lineEdit = new KLineEdit(this);
     lineEdit->setFocusPolicy(Qt::StrongFocus);
     lineEdit->setFrame(true);
     lineEdit->setEchoMode(QLineEdit::Normal);
     lineEdit->setCompletionObject(completion);
     lineEdit->setAutoDeleteCompletionObject(true);
     lineEdit->setWhatsThis(i18n("Into this edit field you can type a phrase. Click on the speak button in order to speak the entered phrase."));
     rowLayout->addWidget(lineEdit);
     lineEdit->setFocus();
 
     QIcon icon = QIcon::fromTheme(QStringLiteral("text-speak"));
     speakButton = new QPushButton(icon, i18n("&Speak"), this);
     speakButton->setFocusPolicy(Qt::NoFocus);
     speakButton->setAutoDefault(false);
     speakButton->setWhatsThis(i18n("Speaks the currently active sentence(s). If there is some text in the edit field it is spoken. Otherwise the selected sentences in the history (if any) are spoken."));
     rowLayout->addWidget(speakButton);
 
     connect(dictionaryCombo, QOverload<const QString &>::of(&KComboBox::textActivated), completion, &WordCompletion::setWordList);
     connect(completion, &WordCompletion::wordListsChanged, this, &PhraseList::configureCompletionCombo);
 
     connect(m_listView->selectionModel(),  &QItemSelectionModel::selectionChanged, this, &PhraseList::selectionChanged);
     connect(m_listView,  &QWidget::customContextMenuRequested, this, &PhraseList::contextMenuRequested);
     connect(lineEdit, &KLineEdit::returnKeyPressed, this, &PhraseList::lineEntered);
     connect(lineEdit, &QLineEdit::textChanged, this, &PhraseList::textChanged);
     connect(speakButton, &QAbstractButton::clicked, this, &PhraseList::speak);
 }
 
 PhraseList::~PhraseList()
 {
     delete speakButton;
     delete m_model;
     delete lineEdit;
 }
 
 void PhraseList::print(QPrinter *pPrinter)
 {
     PhraseBook book;
     QStandardItem *rootItem = m_model->invisibleRootItem();
     int count = rootItem->rowCount();
     for (int i = 0; i < count; ++i) {
         QStandardItem *item = rootItem->child(i);
         book += PhraseBookEntry(Phrase(item->text()));
     }
 
     book.print(pPrinter);
 }
 
 QStringList PhraseList::getListSelection()
 {
     QStringList res = QStringList();
 
     QStandardItem *rootItem = m_model->invisibleRootItem();
     int count = rootItem->rowCount();
     QItemSelectionModel *selection = m_listView->selectionModel();
     for (int i = 0; i < count; ++i) {
         QStandardItem *item = rootItem->child(i);
         if (selection->isSelected(m_model->indexFromItem(item)))
             res += item->text();
     }
 
     return res;
 }
 
 bool PhraseList::existListSelection()
 {
     return m_listView->selectionModel()->hasSelection();
 }
 
 bool PhraseList::existEditSelection()
 {
     return lineEdit->hasSelectedText();
 }
 
 void PhraseList::enableMenuEntries()
 {
     bool deselected = false;
     bool selected = existListSelection();
     QStandardItem *rootItem = m_model->invisibleRootItem();
     int count = rootItem->rowCount();
     QItemSelectionModel *selection = m_listView->selectionModel();
     for (int i = 0; i < count; ++i) {
         QStandardItem *item = rootItem->child(i);
         if (!selection->isSelected(m_model->indexFromItem(item))) {
             deselected = true;
             break;
         }
     }
     KMouthApp *theApp = qobject_cast<KMouthApp*>(parentWidget());
     theApp->enableMenuEntries(selected, deselected);
 }
 
 void PhraseList::configureCompletion()
 {
     completion->configure();
 }
 
 void PhraseList::configureCompletionCombo(const QStringList &list)
 {
     QString current = completion->currentWordList();
     dictionaryCombo->clear();
     if (list.isEmpty())
         dictionaryCombo->hide();
     else if (list.count() == 1) {
         dictionaryCombo->addItems(list);
         dictionaryCombo->setCurrentIndex(0);
         dictionaryCombo->hide();
     } else {
         dictionaryCombo->addItems(list);
         dictionaryCombo->show();
 
         QStringList::ConstIterator it;
         int i = 0;
         for (it = list.begin(), i = 0; it != list.end(); ++it, ++i) {
             if (current == *it) {
                 dictionaryCombo->setCurrentIndex(i);
                 return;
             }
         }
     }
 }
 
 void PhraseList::saveCompletionOptions()
 {
     KConfigGroup cg(KSharedConfig::openConfig(), "General Options");
     cg.writeEntry("Show speak button", speakButton->isVisible() || !lineEdit->isVisible());
 
     KConfigGroup cg2(KSharedConfig::openConfig(), "Completion");
     cg2.writeEntry("Mode", static_cast<int>(lineEdit->completionMode()));
     cg2.writeEntry("List", completion->currentWordList());
 }
 
 void PhraseList::readCompletionOptions()
 {
     KConfigGroup cg(KSharedConfig::openConfig(), "General Options");
     if (!cg.readEntry("Show speak button", true))
         speakButton->hide();
 
     if (KSharedConfig::openConfig()->hasGroup("Completion")) {
         KConfigGroup cg2(KSharedConfig::openConfig(), "Completion");
         //int mode = cg2.readEntry("Mode", int(KGlobalSettings::completionMode()));
         //lineEdit->setCompletionMode(static_cast<KGlobalSettings::Completion>(mode));
 
         QString current = cg2.readEntry("List", QString());
         const QStringList list = completion->wordLists();
         QStringList::ConstIterator it;
         int i = 0;
         for (it = list.constBegin(), i = 0; it != list.constEnd(); ++it, ++i) {
             if (current == *it) {
                 dictionaryCombo->setCurrentIndex(i);
                 return;
             }
         }
     }
 }
 
 void PhraseList::saveWordCompletion()
 {
     completion->save();
 }
 
 
 void PhraseList::selectAllEntries()
 {
     m_listView->selectAll();
 }
 
 void PhraseList::deselectAllEntries()
 {
     m_listView->clearSelection();
 }
 
 void PhraseList::speak()
 {
     QString phrase = lineEdit->text();
     if (phrase.isNull() || phrase.isEmpty())
         speakListSelection();
     else {
         insertIntoPhraseList(phrase, true);
         speakPhrase(phrase);
     }
 }
 
 void PhraseList::cut()
 {
     if (lineEdit->hasSelectedText())
         lineEdit->cut();
     else
         cutListSelection();
 }
 
 void PhraseList::copy()
 {
     if (lineEdit->hasSelectedText())
         lineEdit->copy();
     else
         copyListSelection();
 }
 
 void PhraseList::paste()
 {
     lineEdit->paste();
 }
 
 void PhraseList::insert(const QString &s)
 {
     setEditLineText(s);
 }
 
 void PhraseList::speakListSelection()
 {
     speakPhrase(getListSelection().join(QLatin1String("\n")));
 }
 
 void PhraseList::removeListSelection()
 {
     if (m_listView->selectionModel()->hasSelection()) {
         QList<QModelIndex> selected = m_listView->selectionModel()->selectedRows();
         std::sort(selected.begin(), selected.end());
         // Iterate over the rows backwards so we don't modify the .row of any indexes in selected.
         for (int i = selected.size() - 1; i >= 0; --i) {
             QModelIndex index = selected.at(i);
             m_model->removeRows(index.row(), 1);
         }
     }
     enableMenuEntries();
 }
 
 void PhraseList::cutListSelection()
 {
     copyListSelection();
     removeListSelection();
 }
 
 void PhraseList::copyListSelection()
 {
     QApplication::clipboard()->setText(getListSelection().join(QLatin1String("\n")));
 }
 
 void PhraseList::lineEntered(const QString &phrase)
 {
     if (phrase.isNull() || phrase.isEmpty())
         speakListSelection();
     else {
         insertIntoPhraseList(phrase, true);
         speakPhrase(phrase);
     }
 }
 
 void PhraseList::speakPhrase(const QString &phrase)
 {
     QApplication::setOverrideCursor(Qt::WaitCursor);
     KMouthApp *theApp = qobject_cast<KMouthApp*>(parentWidget());
     QString language = completion->languageOfWordList(completion->currentWordList());
     theApp->getTTSSystem()->speak(phrase, language);
     QApplication::restoreOverrideCursor();
 }
 
 void PhraseList::insertIntoPhraseList(const QString &phrase, bool clearEditLine)
 {
     int lastLine = m_model->rowCount() - 1;
     if ((lastLine == -1) || (phrase != m_model->data(m_model->index(lastLine, 0)).toString())) {
         QStandardItem *item = new QStandardItem(phrase);
         m_model->appendRow(item);
         if (clearEditLine)
             completion->addSentence(phrase);
     }
 
     if (clearEditLine) {
         lineEdit->selectAll();
         line.clear();
     }
     enableMenuEntries();
 }
 
 void PhraseList::contextMenuRequested(const QPoint &pos)
 {
     QString name;
     if (existListSelection())
         name = QStringLiteral("phraselist_selection_popup");
     else
         name = QStringLiteral("phraselist_popup");
 
     KMouthApp *theApp = qobject_cast<KMouthApp*>(parentWidget());
     KXMLGUIFactory *factory = theApp->factory();
     QMenu *popup = (QMenu *)factory->container(name, theApp);
     if (popup != nullptr) {
         popup->exec(pos, nullptr);
     }
 }
 
 void PhraseList::textChanged(const QString &s)
 {
     if (!isInSlot) {
         isInSlot = true;
         line = s;
         m_listView->setCurrentIndex(m_model->index(m_model->rowCount() - 1, 0));
         m_listView->clearSelection();
         isInSlot = false;
     }
 }
 
 void PhraseList::selectionChanged()
 {
     if (!isInSlot) {
         isInSlot = true;
 
         QStringList sel = getListSelection();
 
         if (sel.empty())
             setEditLineText(line);
         else if (sel.count() == 1)
             setEditLineText(sel.first());
         else {
             setEditLineText(QLatin1String(""));
         }
         isInSlot = false;
     }
     enableMenuEntries();
 }
 
 void PhraseList::setEditLineText(const QString &s)
 {
     lineEdit->end(false);
     while (!(lineEdit->text().isNull() || lineEdit->text().isEmpty()))
         lineEdit->backspace();
     lineEdit->insert(s);
 }
 
 void PhraseList::keyPressEvent(QKeyEvent *e)
 {
     if (e->key() == Qt::Key_Up) {
         bool selected = m_listView->selectionModel()->hasSelection();
 
         if (!selected) {
             m_listView->setCurrentIndex(m_model->index(m_model->rowCount() - 1, 0));
             //listBox->ensureCurrentVisible ();
         } else {
             int curr = m_listView->currentIndex().row();
 
             if (curr == -1) {
                 isInSlot = true;
                 m_listView->clearSelection();
                 isInSlot = false;
                 curr = m_model->rowCount() - 1;
                 m_listView->setCurrentIndex(m_model->index(curr, 0));
                 //listBox->ensureCurrentVisible ();
             } else if (curr != 0) {
                 isInSlot = true;
                 m_listView->clearSelection();
                 isInSlot = false;
                 m_listView->setCurrentIndex(m_model->index(curr - 1, 0));
                 //listBox->ensureCurrentVisible ();
             }
         }
 
         e->accept();
     } else if (e->key() == Qt::Key_Down) {
         bool selected = m_listView->selectionModel()->hasSelection();
 
         if (selected) {
             int curr = m_listView->currentIndex().row();
 
             if (curr == (int)m_model->rowCount() - 1) {
                 m_listView->clearSelection();
             } else if (curr != -1) {
                 isInSlot = true;
                 m_listView->clearSelection();
                 isInSlot = false;
                 m_listView->setCurrentIndex(m_model->index(curr + 1, 0));
                 //listBox->ensureCurrentVisible ();
             }
         }
         e->accept();
     } else if (e->modifiers() & Qt::ControlModifier) {
         if (e->key() == Qt::Key_C) {
             copy();
             e->accept();
         } else if (e->key() == Qt::Key_X) {
             cut();
             e->accept();
         }
     } else
         e->ignore();
 }
 
 void PhraseList::save()
 {
     // We want to save a history of spoken sentences here. However, as
     // the class PhraseBook does already provide a method for saving
     // phrase books in both the phrase book format and plain text file
     // format we use that method here.
 
     PhraseBook book;
     QStandardItem *rootItem = m_model->invisibleRootItem();
     int count = m_model->rowCount();
     for (int i = 0; i < count; ++i) {
         QStandardItem *item = rootItem->child(i);
         book += PhraseBookEntry(Phrase(item->text()));
     }
 
     QUrl url;
     if (book.save(this, i18n("Save As"), url, false) == -1)
         KMessageBox::error(this, i18n("There was an error saving file\n%1", url.url()));
 }
 
 void PhraseList::open()
 {
     QUrl url = QFileDialog::getOpenFileUrl(this, i18n("Open File as History"), QUrl(),
                                            i18n("All Files (*);;Phrase Books (*.phrasebook);;Plain Text Files (*.txt)"));
 
     if (!url.isEmpty())
         open(url);
 }
 
 void PhraseList::open(const QUrl &url)
 {
     // We want to open a history of spoken sentences here. However, as
     // the class PhraseBook does already provide a method for opening
     // both phrase books and plain text files we use that method here.
 
     PhraseBook book;
     if (book.open(url)) {
         // convert PhraseBookEntryList -> QStringList
         QStringList list = book.toStringList();
         m_model->clear();
         QStringList::iterator it;
         for (it = list.begin(); it != list.end(); ++it)
             insertIntoPhraseList(*it, false);
     } else
         KMessageBox::error(this, i18n("There was an error loading file\n%1", url.toDisplayString()));
 }