khistorycombobox.cpp

/*
    This file is part of the KDE libraries
 
    SPDX-FileCopyrightText: 2000, 2001 Dawit Alemayehu <adawit@kde.org>
    SPDX-FileCopyrightText: 2000, 2001 Carsten Pfeiffer <pfeiffer@kde.org>
    SPDX-FileCopyrightText: 2000 Stefan Schimanski <1Stein@gmx.de>
 
    SPDX-License-Identifier: LGPL-2.1-or-later
*/
 
#include "khistorycombobox.h"
#include "kcombobox_p.h"
 
#include <KStandardShortcut>
 
#include <QAbstractItemView>
#include <QApplication>
#include <QComboBox>
#include <QMenu>
#include <QWheelEvent>
 
class KHistoryComboBoxPrivate : public KComboBoxPrivate
{
    Q_DECLARE_PUBLIC(KHistoryComboBox)
 
public:
    KHistoryComboBoxPrivate(KHistoryComboBox *q)
        : KComboBoxPrivate(q)
    {
    }
 
    void init(bool useCompletion);
    void rotateUp();
    void rotateDown();
 
    /**
     * Called from the popupmenu,
     * calls clearHistory() and emits cleared()
     */
    void _k_clear();
 
    /**
     * Appends our own context menu entry.
     */
    void _k_addContextMenuItems(QMenu *);
 
    /**
     * Used to emit the activated(QString) signal when enter is pressed
     */
    void _k_simulateActivated(const QString &);
 
    /**
     * The text typed before Up or Down was pressed.
     */
    QString typedText;
 
    /**
     * The current index in the combobox, used for Up and Down
     */
    int currentIndex;
 
    /**
     * Indicates that the user at least once rotated Up through the entire list
     * Needed to allow going back after rotation.
     */
    bool rotated = false;
 
    std::function<QIcon(QString)> iconProvider;
};
 
void KHistoryComboBoxPrivate::init(bool useCompletion)
{
    Q_Q(KHistoryComboBox);
    // Set a default history size to something reasonable, Qt sets it to INT_MAX by default
    q->setMaxCount(50);
 
    if (useCompletion) {
        q->completionObject()->setOrder(KCompletion::Weighted);
    }
 
    q->setInsertPolicy(KHistoryComboBox::NoInsert);
    currentIndex = -1;
    rotated = false;
 
    // obey HISTCONTROL setting
    QByteArray histControl = qgetenv("HISTCONTROL");
    if (histControl == "ignoredups" || histControl == "ignoreboth") {
        q->setDuplicatesEnabled(false);
    }
 
    q->connect(q, &KComboBox::aboutToShowContextMenu, q, [this](QMenu *menu) {
        _k_addContextMenuItems(menu);
    });
    QObject::connect(q, qOverload<int>(&QComboBox::activated), q, &KHistoryComboBox::reset);
    QObject::connect(q, qOverload<const QString &>(&KComboBox::returnPressed), q, [q]() {
        q->reset();
    });
    // We want _k_simulateActivated to be called _after_ QComboBoxPrivate::_q_returnPressed
    // otherwise there's a risk of emitting activated twice (_k_simulateActivated will find
    // the item, after some app's slotActivated inserted the item into the combo).
    q->connect(
        q,
        qOverload<const QString &>(&KComboBox::returnPressed),
        q,
        [this](const QString &text) {
            _k_simulateActivated(text);
        },
        Qt::QueuedConnection);
}
 
// we are always read-write
KHistoryComboBox::KHistoryComboBox(QWidget *parent)
    : KComboBox(*new KHistoryComboBoxPrivate(this), parent)
{
    Q_D(KHistoryComboBox);
    d->init(true); // using completion
    setEditable(true);
}
 
// we are always read-write
KHistoryComboBox::KHistoryComboBox(bool useCompletion, QWidget *parent)
    : KComboBox(*new KHistoryComboBoxPrivate(this), parent)
{
    Q_D(KHistoryComboBox);
    d->init(useCompletion);
    setEditable(true);
}
 
KHistoryComboBox::~KHistoryComboBox()
{
}
 
void KHistoryComboBox::setHistoryItems(const QStringList &items)
{
    setHistoryItems(items, false);
}
 
void KHistoryComboBox::setHistoryItems(const QStringList &items, bool setCompletionList)
{
    QStringList insertingItems = items;
    KComboBox::clear();
 
    // limit to maxCount()
    const int itemCount = insertingItems.count();
    const int toRemove = itemCount - maxCount();
 
    if (toRemove >= itemCount) {
        insertingItems.clear();
    } else {
        for (int i = 0; i < toRemove; ++i) {
            insertingItems.pop_front();
        }
    }
 
    insertItems(insertingItems);
 
    if (setCompletionList && useCompletion()) {
        // we don't have any weighting information here ;(
        KCompletion *comp = completionObject();
        comp->setOrder(KCompletion::Insertion);
        comp->setItems(insertingItems);
        comp->setOrder(KCompletion::Weighted);
    }
 
    clearEditText();
}
 
QStringList KHistoryComboBox::historyItems() const
{
    QStringList list;
    const int itemCount = count();
    list.reserve(itemCount);
    for (int i = 0; i < itemCount; ++i) {
        list.append(itemText(i));
    }
 
    return list;
}
 
bool KHistoryComboBox::useCompletion() const
{
    return compObj();
}
 
void KHistoryComboBox::clearHistory()
{
    const QString temp = currentText();
    KComboBox::clear();
    if (useCompletion()) {
        completionObject()->clear();
    }
    setEditText(temp);
}
 
void KHistoryComboBoxPrivate::_k_addContextMenuItems(QMenu *menu)
{
    Q_Q(KHistoryComboBox);
    if (menu) {
        menu->addSeparator();
        QAction *clearHistory =
            menu->addAction(QIcon::fromTheme(QStringLiteral("edit-clear-history")), KHistoryComboBox::tr("Clear &History", "@action:inmenu"), q, [this]() {
                _k_clear();
            });
        if (!q->count()) {
            clearHistory->setEnabled(false);
        }
    }
}
 
void KHistoryComboBox::addToHistory(const QString &item)
{
    Q_D(KHistoryComboBox);
    if (item.isEmpty() || (count() > 0 && item == itemText(0))) {
        return;
    }
 
    bool wasCurrent = false;
    // remove all existing items before adding
    if (!duplicatesEnabled()) {
        int i = 0;
        int itemCount = count();
        while (i < itemCount) {
            if (itemText(i) == item) {
                if (!wasCurrent) {
                    wasCurrent = (i == currentIndex());
                }
                removeItem(i);
                --itemCount;
            } else {
                ++i;
            }
        }
    }
 
    // now add the item
    if (d->iconProvider) {
        insertItem(0, d->iconProvider(item), item);
    } else {
        insertItem(0, item);
    }
 
    if (wasCurrent) {
        setCurrentIndex(0);
    }
 
    const bool useComp = useCompletion();
 
    const int last = count() - 1; // last valid index
    const int mc = maxCount();
    const int stopAt = qMax(mc, 0);
 
    for (int rmIndex = last; rmIndex >= stopAt; --rmIndex) {
        // remove the last item, as long as we are longer than maxCount()
        // remove the removed item from the completionObject if it isn't
        // anymore available at all in the combobox.
        const QString rmItem = itemText(rmIndex);
        removeItem(rmIndex);
        if (useComp && !contains(rmItem)) {
            completionObject()->removeItem(rmItem);
        }
    }
 
    if (useComp) {
        completionObject()->addItem(item);
    }
}
 
bool KHistoryComboBox::removeFromHistory(const QString &item)
{
    if (item.isEmpty()) {
        return false;
    }
 
    bool removed = false;
    const QString temp = currentText();
    int i = 0;
    int itemCount = count();
    while (i < itemCount) {
        if (item == itemText(i)) {
            removed = true;
            removeItem(i);
            --itemCount;
        } else {
            ++i;
        }
    }
 
    if (removed && useCompletion()) {
        completionObject()->removeItem(item);
    }
 
    setEditText(temp);
    return removed;
}
 
// going up in the history, rotating when reaching QListBox::count()
//
// Note: this differs from QComboBox because "up" means ++index here,
// to simulate the way shell history works (up goes to the most
// recent item). In QComboBox "down" means ++index, to match the popup...
//
void KHistoryComboBoxPrivate::rotateUp()
{
    Q_Q(KHistoryComboBox);
    // save the current text in the lineedit
    // (This is also where this differs from standard up/down in QComboBox,
    // where a single keypress can make you lose your typed text)
    if (currentIndex == -1) {
        typedText = q->currentText();
    }
 
    ++currentIndex;
 
    // skip duplicates/empty items
    const int last = q->count() - 1; // last valid index
    const QString currText = q->currentText();
 
    while (currentIndex < last && (currText == q->itemText(currentIndex) || q->itemText(currentIndex).isEmpty())) {
        ++currentIndex;
    }
 
    if (currentIndex >= q->count()) {
        rotated = true;
        currentIndex = -1;
 
        // if the typed text is the same as the first item, skip the first
        if (q->count() > 0 && typedText == q->itemText(0)) {
            currentIndex = 0;
        }
 
        q->setEditText(typedText);
    } else {
        q->setCurrentIndex(currentIndex);
    }
}
 
// going down in the history, no rotation possible. Last item will be
// the text that was in the lineedit before Up was called.
void KHistoryComboBoxPrivate::rotateDown()
{
    Q_Q(KHistoryComboBox);
    // save the current text in the lineedit
    if (currentIndex == -1) {
        typedText = q->currentText();
    }
 
    --currentIndex;
 
    const QString currText = q->currentText();
    // skip duplicates/empty items
    while (currentIndex >= 0 //
           && (currText == q->itemText(currentIndex) || q->itemText(currentIndex).isEmpty())) {
        --currentIndex;
    }
 
    if (currentIndex < 0) {
        if (rotated && currentIndex == -2) {
            rotated = false;
            currentIndex = q->count() - 1;
            q->setEditText(q->itemText(currentIndex));
        } else { // bottom of history
            currentIndex = -1;
            if (q->currentText() != typedText) {
                q->setEditText(typedText);
            }
        }
    } else {
        q->setCurrentIndex(currentIndex);
    }
}
 
void KHistoryComboBox::keyPressEvent(QKeyEvent *e)
{
    Q_D(KHistoryComboBox);
    int event_key = e->key() | e->modifiers();
 
    if (KStandardShortcut::rotateUp().contains(event_key)) {
        d->rotateUp();
    } else if (KStandardShortcut::rotateDown().contains(event_key)) {
        d->rotateDown();
    } else {
        KComboBox::keyPressEvent(e);
    }
}
 
void KHistoryComboBox::wheelEvent(QWheelEvent *ev)
{
    Q_D(KHistoryComboBox);
    // Pass to poppable listbox if it's up
    QAbstractItemView *const iv = view();
    if (iv && iv->isVisible()) {
        QApplication::sendEvent(iv, ev);
        return;
    }
    // Otherwise make it change the text without emitting activated
    if (ev->angleDelta().y() > 0) {
        d->rotateUp();
    } else {
        d->rotateDown();
    }
    ev->accept();
}
 
void KHistoryComboBox::setIconProvider(std::function<QIcon(const QString &)> providerFunction)
{
    Q_D(KHistoryComboBox);
    d->iconProvider = providerFunction;
}
 
void KHistoryComboBox::insertItems(const QStringList &items)
{
    Q_D(KHistoryComboBox);
 
    for (const QString &item : items) {
        if (item.isEmpty()) {
            continue;
        }
 
        if (d->iconProvider) {
            addItem(d->iconProvider(item), item);
        } else {
            addItem(item);
        }
    }
}
 
void KHistoryComboBoxPrivate::_k_clear()
{
    Q_Q(KHistoryComboBox);
    q->clearHistory();
    Q_EMIT q->cleared();
}
 
void KHistoryComboBoxPrivate::_k_simulateActivated(const QString &text)
{
    Q_Q(KHistoryComboBox);
    /* With the insertion policy NoInsert, which we use by default,
       Qt doesn't emit activated on typed text if the item is not already there,
       which is perhaps reasonable. Generate the signal ourselves if that's the case.
    */
    if ((q->insertPolicy() == q->NoInsert && q->findText(text, Qt::MatchFixedString | Qt::MatchCaseSensitive) == -1)) {
        Q_EMIT q->textActivated(text);
    }
 
    /*
       Qt also doesn't emit it if the box is full, and policy is not
       InsertAtCurrent
    */
    else if (q->insertPolicy() != q->InsertAtCurrent && q->count() >= q->maxCount()) {
        Q_EMIT q->textActivated(text);
    }
}
 
void KHistoryComboBox::reset()
{
    Q_D(KHistoryComboBox);
    d->currentIndex = -1;
    d->rotated = false;
}
 
#include "moc_khistorycombobox.cpp"