history_line_edit.cpp

/**
 * \file
 *
 * \author Mattia Basaglia
 *
 * \copyright Copyright (C) 2012-2015 Mattia Basaglia
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#include "history_line_edit.hpp"

#include <QKeyEvent>
#include <QWheelEvent>

#include <QCompleter>
#include <QAbstractItemView>
#include <QScrollBar>

HistoryLineEdit::HistoryLineEdit(QWidget *parent) :
    QLineEdit(parent),
    current_line(0),
    completer(0),
    completion_minchars(1),
    completion_max(0)
{
    connect(this,SIGNAL(returnPressed()),SLOT(execute()));
}

void HistoryLineEdit::keyPressEvent(QKeyEvent * ev)
{
    if ( ev->key() == Qt::Key_Up )
    {
        previous_line();
        return;
    }
    else if ( ev->key() == Qt::Key_Down )
    {
        next_line();
        return;
    }
    else if (completer && completer->popup() && completer->popup()->isVisible())
    {
        switch (ev->key())
        {
            case Qt::Key_Enter:
            case Qt::Key_Return:
            case Qt::Key_F4:
            case Qt::Key_Select:
                completer->popup()->hide();
                return;
        }
    }

    QLineEdit::keyPressEvent(ev);

    if (completer)
    {
        QString current = current_word();
        completer->setCompletionPrefix(current);
        if ( current.size() < completion_minchars ||
            completer->completionCount() == 0 ||
            (completion_max > 0 && completer->completionCount() > completion_max) )
        {
            completer->popup()->hide();
        }
        else
        {
            // Get the selection status
            int sel = selectionStart();
            int sellength = selectedText().size();
            // Get the current cursor position
            int c = cursorPosition();
            // Get the start of the current word
            setCursorPosition(word_start());
            // Get the cursor rectangle at the beginning of the current word
            QRect rect = cursorRect();
            // Restore cursor position (clears the selection)
            setCursorPosition(c);
            // If we had a selection
            if ( sel != -1 )
            {
                // If the selection started at the cursor,
                // it needs to start at the far end and go back
                // (otherwise it moves the cursor at the end)
                if ( sel == c )
                    setSelection(sel+sellength, -sellength);
                else
                    setSelection(sel, sellength);
            }
            // Set the rectangle to the appropriate width
            rect.setWidth(
                completer->popup()->sizeHintForColumn(0)
                + completer->popup()->verticalScrollBar()->sizeHint().width()
            );
            // Display the completer under the rectangle
            completer->complete(rect);
        }
    }
}

void HistoryLineEdit::wheelEvent(QWheelEvent *ev)
{
    if ( ev->delta() > 0 )
        previous_line();
    else
        next_line();
}

void HistoryLineEdit::previous_line()
{
    if ( lines.empty() )
        return;

    if ( !text().isEmpty() &&
         ( current_line >= lines.size() || text() != lines[current_line] ) )
        unfinished = text();

    if ( current_line > 0 )
        current_line--;

    setText(lines[current_line]);
}


void HistoryLineEdit::next_line()
{
    if ( lines.empty() )
        return;

    current_line++;

    if ( current_line >= lines.size() )
    {
        setText(unfinished);
        unfinished = "";
        current_line = lines.size();
    }
    else
        setText(lines[current_line]);
}

void HistoryLineEdit::execute()
{
    if ( lines.empty() || lines.back() != text() )
        lines << text();
    current_line = lines.size();
    clear();
    emit lineExecuted(lines.back());
}

void HistoryLineEdit::setHistory(const QStringList& history)
{
    lines = history;
    current_line = lines.size();
}

int HistoryLineEdit::word_start() const
{
    // lastIndexOf returns the index of the last space or -1 if there are no spaces
    // so that + 1 returns the index of the character starting the word or 0
    int after_space = text().leftRef(cursorPosition()).lastIndexOf(' ') + 1;
    if ( text().rightRef(text().size()-after_space).startsWith(completion_prefix) )
        after_space += completion_prefix.size();
    return after_space;
}

QString HistoryLineEdit::current_word() const
{
    int completion_index = word_start();
    return text().mid(completion_index, cursorPosition() - completion_index);
}

void HistoryLineEdit::autocomplete(const QString& completion)
{
    int completion_index = word_start();
    setText(text().replace(
        completion_index, cursorPosition() - completion_index,
        completion
    ));
    setCursorPosition(completion_index+completion.size());
}

void HistoryLineEdit::setWordCompleter(QCompleter* comp)
{
    if ( completer )
    {
        disconnect(completer, 0, this, 0);
        completer->setWidget(0);
    }

    completer = comp;

    if ( comp )
    {
        /// \todo should set these only when on focus
        connect(completer, SIGNAL(activated(QString)),
                this,      SLOT(autocomplete(QString)));
        connect(completer, SIGNAL(highlighted(QString)),
                this,      SLOT(autocomplete(QString)));
        completer->setWidget(this);
    }
}

void HistoryLineEdit::setWordCompleterPrefix(const QString& prefix)
{
    completion_prefix = prefix;
}

void HistoryLineEdit::setWordCompleterMinChars(int min_chars)
{
    completion_minchars = min_chars;
}

void HistoryLineEdit::setWordCompleterMaxSuggestions(int max)
{
    completion_max = max;
}