File indexing completed on 2024-04-28 16:54:25

 /*
     SPDX-FileCopyrightText: 2004 Esben Mose Hansen <kde@mosehansen.dk>
     SPDX-FileCopyrightText: Andrew Stanley-Jones <asj@cban.com>
     SPDX-FileCopyrightText: 2000 Carsten Pfeiffer <pfeiffer@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "klipperpopup.h"
 
 #include "klipper_debug.h"
 #include <QGuiApplication>
 #include <QKeyEvent>
 #include <QScreen>
 #include <QWidgetAction>
 
 #include <KColorScheme>
 #include <KHelpMenu>
 #include <KLineEdit>
 #include <KLocalizedString>
 #include <KWindowInfo>
 
 #include "history.h"
 #include "klipper.h"
 #include "popupproxy.h"
 
 namespace
 {
 // Index 0 is the menu header, index 1 is the search widget.
 static const int TOP_HISTORY_ITEM_INDEX = 2;
 }
 
 // #define DEBUG_EVENTS__
 
 #ifdef DEBUG_EVENTS__
 kdbgstream &operator<<(kdbgstream &stream, const QKeyEvent &e)
 {
     stream << "(QKeyEvent(text=" << e.text() << ",key=" << e.key() << (e.isAccepted() ? ",accepted" : ",ignored)") << ",count=" << e.count();
     if (e.modifiers() & Qt::AltModifier) {
         stream << ",ALT";
     }
     if (e.modifiers() & Qt::ControlModifier) {
         stream << ",CTRL";
     }
     if (e.modifiers() & Qt::MetaModifier) {
         stream << ",META";
     }
     if (e.modifiers() & Qt::ShiftModifier) {
         stream << ",SHIFT";
     }
     if (e.isAutoRepeat()) {
         stream << ",AUTOREPEAT";
     }
     stream << ")";
 
     return stream;
 }
 #endif
 
 KlipperPopup::KlipperPopup(History *history)
     : m_dirty(true)
     , m_history(history)
     , m_popupProxy(nullptr)
     , m_filterWidget(nullptr)
     , m_filterWidgetAction(nullptr)
     , m_lastEvent(nullptr)
 {
     ensurePolished();
     KWindowInfo windowInfo(winId(), NET::WMGeometry);
     QRect geometry = windowInfo.geometry();
     QScreen *screen = QGuiApplication::screenAt(geometry.center());
     if (screen == nullptr) {
         screen = QGuiApplication::screens()[0];
     }
     int menuHeight = (screen->geometry().height()) * 3 / 4;
     int menuWidth = (screen->geometry().width()) * 1 / 3;
 
     m_popupProxy = new PopupProxy(this, menuHeight, menuWidth);
 
     connect(this, &KlipperPopup::aboutToShow, this, &KlipperPopup::slotAboutToShow);
 }
 
 void KlipperPopup::slotAboutToShow()
 {
     if (m_filterWidget) {
         if (!m_filterWidget->text().isEmpty()) {
             m_dirty = true;
             m_filterWidget->clear();
         }
     }
     ensureClean();
 }
 
 void KlipperPopup::ensureClean()
 {
     // If the history is unchanged since last menu build, there is no reason
     // to rebuild it,
     if (m_dirty) {
         rebuild();
     }
 }
 
 void KlipperPopup::buildFromScratch()
 {
     addSection(QIcon::fromTheme(QStringLiteral("klipper")),
                i18nc("%1 is application display name", "%1 - Clipboard Items", QGuiApplication::applicationDisplayName()));
 
     m_filterWidget = new KLineEdit(this);
     m_filterWidget->setFocusPolicy(Qt::NoFocus);
     m_filterWidget->setPlaceholderText(i18n("Search…"));
     m_filterWidgetAction = new QWidgetAction(this);
     m_filterWidgetAction->setDefaultWidget(m_filterWidget);
     addAction(m_filterWidgetAction);
 
     Q_ASSERT(actions().count() == TOP_HISTORY_ITEM_INDEX);
 }
 
 void KlipperPopup::showStatus(const QString &errorText)
 {
     const KColorScheme colorScheme(QPalette::Normal, KColorScheme::View);
     QPalette palette = m_filterWidget->palette();
 
     if (errorText.isEmpty()) { // no error
         palette.setColor(m_filterWidget->foregroundRole(), colorScheme.foreground(KColorScheme::NormalText).color());
         palette.setColor(m_filterWidget->backgroundRole(), colorScheme.background(KColorScheme::NormalBackground).color());
         // add no action, rebuild() will fill with history items
     } else { // there is an error
         palette.setColor(m_filterWidget->foregroundRole(), colorScheme.foreground(KColorScheme::NegativeText).color());
         palette.setColor(m_filterWidget->backgroundRole(), colorScheme.background(KColorScheme::NegativeBackground).color());
         addAction(new QAction(errorText, this));
     }
 
     m_filterWidget->setPalette(palette);
 }
 
 void KlipperPopup::rebuild(const QString &filter)
 {
     if (actions().isEmpty()) {
         buildFromScratch();
     } else {
         while (actions().count() > TOP_HISTORY_ITEM_INDEX) {
             // The old actions allocated by KlipperPopup::rebuild()
             // and PopupProxy::tryInsertItem() are deleted here when
             // the menu is rebuilt.
             QAction *action = actions().last();
             removeAction(action);
             action->deleteLater();
         }
     }
 
     QRegularExpression filterexp(filter);
     // The search is case insensitive unless at least one uppercase character
     // appears in the search term.
     //
     // This is not really a rigourous check, since the test below for an
     // uppercase character should really check for an uppercase character that
     // is not part of a special regexp character class or escape sequence:
     // for example, using "\S" to mean a non-whitespace character should not
     // force the match to be case sensitive.  However, that is not possible
     // without fully parsing the regexp.  The user is not likely to be searching
     // for complex regular expressions here.
     if (filter.toLower() == filter) {
         filterexp.setPatternOptions(QRegularExpression::CaseInsensitiveOption);
     }
 
     QString errorText;
     if (!filterexp.isValid()) {
         errorText = i18n("Invalid regular expression, %1", filterexp.errorString());
     } else {
         const int nHistoryItems = m_popupProxy->buildParent(TOP_HISTORY_ITEM_INDEX, filterexp);
         if (nHistoryItems == 0) {
             if (m_history->empty()) {
                 errorText = i18n("Clipboard is empty");
             } else {
                 errorText = i18n("No matches");
             }
         } else {
             if (history()->topIsUserSelected()) {
                 QAction *topAction = actions().at(TOP_HISTORY_ITEM_INDEX);
                 topAction->setCheckable(true);
                 topAction->setChecked(true);
             }
         }
     }
 
     showStatus(errorText);
     m_dirty = false;
 }
 
 void KlipperPopup::slotTopIsUserSelectedSet()
 {
     if (!m_dirty && actions().count() > TOP_HISTORY_ITEM_INDEX && history()->topIsUserSelected()) {
         QAction *topAction = actions().at(TOP_HISTORY_ITEM_INDEX);
         topAction->setCheckable(true);
         topAction->setChecked(true);
     }
 }
 
 void KlipperPopup::showEvent(QShowEvent *)
 {
     popup(QCursor::pos());
 }
 
 void KlipperPopup::keyPressEvent(QKeyEvent *e)
 {
     // Most events are send down directly to the m_filterWidget.
     // If the m_filterWidget does not handle the event, it will
     // come back to this method. Remembering the last event stops
     // the infinite event loop
     if (m_lastEvent == e) {
         m_lastEvent = nullptr;
         return;
     }
     m_lastEvent = e;
     // If alt-something is pressed, select a shortcut
     // from the menu. Do this by sending a keyPress
     // without the alt-modifier to the superobject.
     if (e->modifiers() & Qt::AltModifier) {
         QKeyEvent ke(QEvent::KeyPress, e->key(), e->modifiers() ^ Qt::AltModifier, e->text(), e->isAutoRepeat(), e->count());
         QMenu::keyPressEvent(&ke);
 #ifdef DEBUG_EVENTS__
         qCDebug(KLIPPER_LOG) << "Passing this event to ancestor (KMenu): " << e << "->" << ke;
 #endif
         if (ke.isAccepted()) {
             e->accept();
             return;
         } else {
             e->ignore();
         }
     }
 
     // Otherwise, send most events to the search
     // widget, except a few used for navigation:
     // These go to the superobject.
     switch (e->key()) {
     case Qt::Key_Up:
     case Qt::Key_Down:
     case Qt::Key_Right:
     case Qt::Key_Left:
     case Qt::Key_Tab:
     case Qt::Key_Backtab:
     case Qt::Key_Escape: {
 #ifdef DEBUG_EVENTS__
         qCDebug(KLIPPER_LOG) << "Passing this event to ancestor (KMenu): " << e;
 #endif
         QMenu::keyPressEvent(e);
 
         break;
     }
     case Qt::Key_Return:
     case Qt::Key_Enter: {
         QMenu::keyPressEvent(e);
         this->hide();
 
         if (activeAction() == m_filterWidgetAction)
             setActiveAction(actions().at(TOP_HISTORY_ITEM_INDEX));
 
         break;
     }
     default: {
 #ifdef DEBUG_EVENTS__
         qCDebug(KLIPPER_LOG) << "Passing this event down to child (KLineEdit): " << e;
 #endif
         setActiveAction(actions().at(actions().indexOf(m_filterWidgetAction)));
         QString lastString = m_filterWidget->text();
 
         QCoreApplication::sendEvent(m_filterWidget, e);
         if (m_filterWidget->text() != lastString) {
             m_dirty = true;
             rebuild(m_filterWidget->text());
         }
 
         break;
     } // default:
     } // case
     m_lastEvent = nullptr;
 }
 
 void KlipperPopup::slotSetTopActive()
 {
     if (actions().size() > TOP_HISTORY_ITEM_INDEX) {
         setActiveAction(actions().at(TOP_HISTORY_ITEM_INDEX));
     }
 }