]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/GuiCompleter.cpp
Complete the removal of the embedding stuff. Maybe. It's hard to be sure we got every...
[lyx.git] / src / frontends / qt4 / GuiCompleter.cpp
index 20ad50f4717495a7a172c0d8e53f4710b343fed3..c22eaa0fb3c3fa582537f57ca019ef887c441b92 100644 (file)
 
 #include "Buffer.h"
 #include "BufferView.h"
+#include "CompletionList.h"
 #include "Cursor.h"
 #include "Dimension.h"
 #include "FuncRequest.h"
 #include "GuiView.h"
 #include "LyXFunc.h"
 #include "LyXRC.h"
+#include "Paragraph.h"
 #include "version.h"
 
+#include "support/assert.h"
 #include "support/debug.h"
 
 #include <QApplication>
-#include <QAbstractListModel>
 #include <QHeaderView>
 #include <QPainter>
 #include <QPixmapCache>
@@ -40,11 +42,45 @@ using namespace lyx::support;
 namespace lyx {
 namespace frontend {
 
+class RtlItemDelegate : public QItemDelegate
+{
+public:
+       explicit RtlItemDelegate(QObject * parent)
+               : QItemDelegate(parent), enabled_(false)
+       {}
+
+       void setEnabled(bool enabled = true)
+       {
+               enabled_ = enabled;
+       }
+       
+protected:
+       void drawDisplay(QPainter * painter,
+               QStyleOptionViewItem const & option,
+               QRect const & rect, QString const & text) const
+       {
+               if (!enabled_) {
+                       QItemDelegate::drawDisplay(painter, option, rect, text);
+                       return;
+               }
 
-class PixmapItemDelegate : public QItemDelegate {
+               // FIXME: do this more elegantly
+               docstring stltext = qstring_to_ucs4(text);
+               reverse(stltext.begin(), stltext.end());
+               QItemDelegate::drawDisplay(painter, option, rect, toqstr(stltext));
+       }
+       
+private:
+       bool enabled_;
+};
+
+
+class PixmapItemDelegate : public QItemDelegate
+{
 public:
-       explicit PixmapItemDelegate(QObject *parent = 0)
-       : QItemDelegate(parent) {}
+       explicit PixmapItemDelegate(QObject * parent)
+               : QItemDelegate(parent)
+       {}
 
 protected:
        void paint(QPainter *painter, const QStyleOptionViewItem &option,
@@ -69,14 +105,22 @@ protected:
 };
 
 
-class GuiCompletionModel : public QAbstractListModel {
+class GuiCompletionModel : public QAbstractListModel
+{
 public:
        ///
-       GuiCompletionModel(QObject * parent, Inset::CompletionList const * l)
-       : QAbstractListModel(parent), list_(l) {}
+       GuiCompletionModel(QObject * parent, CompletionList const * l)
+               : QAbstractListModel(parent), list_(l)
+       {}
+       ///
+       ~GuiCompletionModel() { delete list_; }
        ///
-       ~GuiCompletionModel()
-               { delete list_; }
+       bool sorted() const
+       {
+               if (list_)
+                       return list_->sorted();
+               return false;
+       }
        ///
        int columnCount(const QModelIndex & /*parent*/ = QModelIndex()) const
        {
@@ -105,7 +149,8 @@ public:
                    
                if (index.column() == 0)
                        return toqstr(list_->data(index.row()));
-               else if (index.column() == 1) {
+
+               if (index.column() == 1) {
                        // get icon from cache
                        QPixmap scaled;
                        QString const name = ":" + toqstr(list_->icon(index.row()));
@@ -114,8 +159,7 @@ public:
                                QPixmap p = QPixmap(name);
                                if (!p.isNull()) {
                                        // scale it to 16x16 or smaller
-                                       scaled
-                                       = p.scaled(min(16, p.width()), min(16, p.height()), 
+                                       scaled = p.scaled(min(16, p.width()), min(16, p.height()), 
                                                Qt::KeepAspectRatio, Qt::SmoothTransformation);
                                }
 
@@ -127,13 +171,15 @@ public:
        }
 
 private:
-       ///
-       Inset::CompletionList const * list_;
+       /// owned by us
+       CompletionList const * list_;
 };
 
 
 GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
-       : QCompleter(parent), gui_(gui), updateLock_(0)
+       : QCompleter(parent), gui_(gui), updateLock_(0),
+         inlineVisible_(false), popupVisible_(false),
+         modelActive_(false)
 {
        // Setup the completion popup
        setModel(new GuiCompletionModel(this, 0));
@@ -148,8 +194,12 @@ GuiCompleter::GuiCompleter(GuiWorkArea * gui, QObject * parent)
         listView->setSelectionMode(QAbstractItemView::SingleSelection);
        listView->header()->hide();
        listView->setIndentation(0);
+       listView->setUniformRowHeights(true);
        setPopup(listView);
-       popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(popup()));
+       
+       rtlItemDelegate_ = new RtlItemDelegate(this);
+       popup()->setItemDelegateForColumn(0, rtlItemDelegate_);
+       popup()->setItemDelegateForColumn(1, new PixmapItemDelegate(this));
        
        // create timeout timers
        popup_timer_.setSingleShot(true);
@@ -204,15 +254,37 @@ bool GuiCompleter::inlinePossible(Cursor const & cur) const
 }
 
 
+bool GuiCompleter::completionAvailable() const
+{
+       if (!modelActive_)
+               return false;
+
+       size_t n = popup()->model()->rowCount();
+
+       // if there is exactly one, we have to check whether it is a 
+       // real completion, i.e. longer than the current prefix.
+       if (n == 1 && completionPrefix() == currentCompletion())
+           return false;
+
+       return n > 0;
+}
+
+
 bool GuiCompleter::popupVisible() const
 {
-       return popup()->isVisible();
+       return popupVisible_;
 }
 
 
 bool GuiCompleter::inlineVisible() const
 {
-       return !gui_->bufferView().inlineCompletionPos().empty();
+       // In fact using BufferView::inlineCompletionPos.empty() should be
+       // here. But unfortunately this information is not good enough
+       // because destructive operations like backspace might invalidate
+       // inlineCompletionPos. But then the completion should stay visible
+       // (i.e. reshown on the next update). Hence be keep this information
+       // in the inlineVisible_ variable.
+       return inlineVisible_;
 }
 
 
@@ -227,26 +299,12 @@ void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cu
        bool possibleInlineState = inlinePossible(cur) && cursorInView;
 
        // we moved or popup state is not ok for popup?
-       if ((moved && !keep) || !possiblePopupState) {
-               // stop an old completion timer
-               if (popup_timer_.isActive())
-                       popup_timer_.stop();
-
-               // hide old popup
-               if (popupVisible())
-                       popup()->hide();
-       }
+       if ((moved && !keep) || !possiblePopupState)
+               hidePopup(cur);
 
        // we moved or inline state is not ok for inline completion?
-       if ((moved && !keep) || !possibleInlineState) {
-               // stop an old completion timer
-               if (inline_timer_.isActive())
-                       inline_timer_.stop();
-
-               // hide old inline completion
-               if (inlineVisible())
-                       gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
-       }
+       if ((moved && !keep) || !possibleInlineState)
+               hideInline(cur);
 
        // we inserted something and are in a possible popup state?
        if (!popupVisible() && possiblePopupState && start
@@ -258,10 +316,14 @@ void GuiCompleter::updateVisibility(Cursor & cur, bool start, bool keep, bool cu
                && cur.inset().automaticInlineCompletion())
                inline_timer_.start(int(lyxrc.completion_inline_delay * 1000));
 
-       // update prefix if popup is visible or if it will be visible soon
-       if (popupVisible() || inlineVisible()
-           || popup_timer_.isActive() || inline_timer_.isActive())
-               updatePrefix(cur);
+       // update prefix if any completion is possible
+       bool modelActive = modelActive_ && model()->rowCount() > 0;
+       if (possiblePopupState || possibleInlineState) {
+               if (modelActive)
+                       updatePrefix(cur);
+               else
+                       updateAvailability();
+       }
 }
 
 
@@ -291,7 +353,7 @@ void GuiCompleter::updatePrefix(Cursor & cur)
        
        // update completer to new prefix
        setCompletionPrefix(newPrefix);
-       
+
        // update popup because its size might have changed
        if (popupVisible())
                updatePopup(cur);
@@ -302,11 +364,13 @@ void GuiCompleter::updatePrefix(Cursor & cur)
        // if popup is not empty, the new selection will
        // be our last valid one
        QString const & s = currentCompletion();
-       if (s.length() > 0)
-               last_selection_ = s;
-       else
-               last_selection_ = old;
-       
+       if (popupVisible() || inlineVisible()) {
+               if (s.length() > 0)
+                       last_selection_ = s;
+               else
+                       last_selection_ = old;
+       }
+
        // update inline completion because the default
        // completion string might have changed
        if (inlineVisible())
@@ -331,6 +395,7 @@ void GuiCompleter::updateInline(Cursor & cur, QString const & completion)
        // set inline completion at cursor position
        size_t uniqueTo = max(longestUniqueCompletion().size(), prefix.size());
        gui_->bufferView().setInlineCompletion(cur, cur, postfix, uniqueTo - prefix.size());
+       inlineVisible_ = true;
 }
 
 
@@ -339,33 +404,101 @@ void GuiCompleter::updatePopup(Cursor & cur)
        if (!cur.inset().completionSupported(cur))
                return;
        
-       if (completionCount() == 0)
+       popupVisible_ = true;
+
+       if (completionCount() == 0) {
+               QTimer::singleShot(0, popup(), SLOT(hide()));
                return;
-       
+       }
+
+       QTimer::singleShot(0, this, SLOT(asyncUpdatePopup()));
+}
+
+
+void GuiCompleter::asyncUpdatePopup()
+{
+       Cursor cur = gui_->bufferView().cursor();
+       if (!cur.inset().completionSupported(cur)) {
+               popupVisible_ = false;
+               return;
+       }
+
        // get dimensions of completion prefix
        Dimension dim;
        int x;
        int y;
        cur.inset().completionPosAndDim(cur, x, y, dim);
-       QRect insetRect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
+       
+       // and calculate the rect of the popup
+       QRect rect;
+       if (popup()->layoutDirection() == Qt::RightToLeft)
+               rect = QRect(x + dim.width() - 200, y - dim.ascent() - 3, 200, dim.height() + 6);
+       else
+               rect = QRect(x, y - dim.ascent() - 3, 200, dim.height() + 6);
+       
+       // Resize the columns in the popup.
+       // This should really be in the constructor. But somehow the treeview
+       // has a bad memory about it and we have to tell him again and again.
+       QTreeView * listView = static_cast<QTreeView *>(popup());
+       listView->header()->setStretchLastSection(false);
+       listView->header()->setResizeMode(0, QHeaderView::Stretch);
+       listView->header()->setResizeMode(1, QHeaderView::Fixed);
+       listView->header()->resizeSection(1, 22);
        
        // show/update popup
-       complete(insetRect);
-       QTreeView * p = static_cast<QTreeView *>(popup());
-       p->setColumnWidth(0, popup()->width() - 22 - p->verticalScrollBar()->width());
+       complete(rect);
 }
 
 
+void GuiCompleter::updateAvailability()
+{
+       // this should really only be of interest if no completion is
+       // visible yet, i.e. especially if automatic completion is disabled.
+       if (inlineVisible() || popupVisible())
+               return;
+       Cursor & cur = gui_->bufferView().cursor();
+       if (!popupPossible(cur) && !inlinePossible(cur))
+               return;
+       
+       updateModel(cur, false, false);
+}
+       
+
 void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate)
 {
        // value which should be kept selected
        QString old = currentCompletion();
        if (old.length() == 0)
                old = last_selection_;
-       
+
+       // set whether rtl
+       bool rtl = false;
+       if (cur.inTexted()) {
+               Paragraph const & par = cur.paragraph();
+               Font const font =
+               par.getFontSettings(cur.bv().buffer().params(), cur.pos());
+               rtl = font.isVisibleRightToLeft();
+       }
+       popup()->setLayoutDirection(rtl ? Qt::RightToLeft : Qt::LeftToRight);
+
+       // turn the direction of the strings in the popup.
+       // Qt does not do that itself.
+       rtlItemDelegate_->setEnabled(rtl);
+
        // set new model
-       setModel(new GuiCompletionModel(this, cur.inset().completionList(cur)));
-       
+       CompletionList const * list = cur.inset().createCompletionList(cur);
+       setModel(new GuiCompletionModel(this, list));
+       modelActive_ = true;
+       if (list->sorted())
+               setModelSorting(QCompleter::CaseSensitivelySortedModel);
+       else
+               setModelSorting(QCompleter::UnsortedModel);
+
+       // set prefix
+       QString newPrefix = toqstr(cur.inset().completionPrefix(cur));
+       if (newPrefix != completionPrefix())
+               setCompletionPrefix(newPrefix);
+
        // show popup
        if (popupUpdate)
                updatePopup(cur);
@@ -375,12 +508,14 @@ void GuiCompleter::updateModel(Cursor & cur, bool popupUpdate, bool inlineUpdate
        
        // if popup is not empty, the new selection will
        // be our last valid one
-       QString const & s = currentCompletion();
-       if (s.length() > 0)
-               last_selection_ = s;
-       else
-               last_selection_ = old;
-       
+       if (popupVisible() || inlineVisible()) {
+               QString const & s = currentCompletion();
+               if (s.length() > 0)
+                       last_selection_ = s;
+               else
+                       last_selection_ = old;
+       }
+
        // show inline completion
        if (inlineUpdate)
                updateInline(cur, currentCompletion());
@@ -393,9 +528,36 @@ void GuiCompleter::showPopup(Cursor & cur)
                return;
        
        updateModel(cur, true, inlineVisible());
-       updatePrefix(cur);
 }
+
+
+void GuiCompleter::hidePopup(Cursor &)
+{
+       popupVisible_ = false;
+
+       if (popup_timer_.isActive())
+               popup_timer_.stop();
+
+       // hide popup asynchronously because we might be here inside of
+       // LFUN dispatchers. Hiding a popup can trigger a focus event on the 
+       // workarea which then redisplays the cursor. But the metrics are not
+       // yet up to date such that the coord cache has not all insets yet. The
+       // cursorPos methods would triggers asserts in the coord cache then.
+       QTimer::singleShot(0, this, SLOT(asyncHidePopup()));
        
+       // mark that the asynchronous part will reset the model
+       if (!inlineVisible())
+               modelActive_ = false;
+}
+
+
+void GuiCompleter::asyncHidePopup()
+{
+       popup()->hide();
+       if (!inlineVisible())
+               setModel(new GuiCompletionModel(this, 0));
+}
+
 
 void GuiCompleter::showInline(Cursor & cur)
 {
@@ -403,7 +565,32 @@ void GuiCompleter::showInline(Cursor & cur)
                return;
        
        updateModel(cur, popupVisible(), true);
-       updatePrefix(cur);
+}
+
+
+void GuiCompleter::hideInline(Cursor & cur)
+{
+       gui_->bufferView().setInlineCompletion(cur, DocIterator(), docstring());
+       inlineVisible_ = false;
+       
+       if (inline_timer_.isActive())
+               inline_timer_.stop();
+       
+       // Trigger asynchronous part of hideInline. We might be
+       // in a dispatcher here and the setModel call might
+       // trigger focus events which is are not healthy here.
+       QTimer::singleShot(0, this, SLOT(asyncHideInline()));
+
+       // mark that the asynchronous part will reset the model
+       if (!popupVisible())
+               modelActive_ = false;
+}
+
+
+void GuiCompleter::asyncHideInline()
+{
+       if (!popupVisible())
+               setModel(new GuiCompletionModel(this, 0));
 }
 
 
@@ -433,15 +620,38 @@ void GuiCompleter::showInline()
 }
 
 
+void GuiCompleter::hidePopup()
+{
+       Cursor cur = gui_->bufferView().cursor();
+       cur.updateFlags(Update::None);
+       
+       hidePopup(cur);
+       
+       // redraw if needed
+       if (cur.disp_.update())
+               gui_->bufferView().processUpdateFlags(cur.disp_.update());
+}
+
+
+void GuiCompleter::hideInline()
+{
+       Cursor cur = gui_->bufferView().cursor();
+       cur.updateFlags(Update::None);
+       
+       hideInline(cur);
+       
+       // redraw if needed
+       if (cur.disp_.update())
+               gui_->bufferView().processUpdateFlags(cur.disp_.update());
+}
+
+
 void GuiCompleter::activate()
 {
        if (!popupVisible() && !inlineVisible())
                return;
 
-       // Complete with current selection in the popup.
-       QString s = currentCompletion();
-       popup()->hide();
-       popupActivated(s);
+       popupActivated(currentCompletion());
 }
 
 
@@ -480,7 +690,10 @@ void GuiCompleter::tab()
        if (completion.size() <= prefix.size()) {
                // finalize completion
                cur.inset().insertCompletion(cur, docstring(), true);
-               popup()->hide();
+               
+               // hide popup and inline completion
+               hidePopup(cur);
+               hideInline(cur);
                updateVisibility(false, false);
                return;
        }
@@ -536,14 +749,50 @@ void GuiCompleter::setCurrentCompletion(QString const & s)
                return;
        }
 
-       // iterate through list until the s is found
-       // FIXME: there must be a better way than this iteration
+       // find old selection in model
        size_t i;
-       for (i = 0; i < n; ++i) {
-               QString const & is
-               = model.data(model.index(i, 0), Qt::EditRole).toString();
-               if (is == s)
-                       break;
+       if (modelSorting() == QCompleter::UnsortedModel) {
+               // In unsorted models, iterate through list until the s is found
+               for (i = 0; i < n; ++i) {
+                       QString const & is
+                       = model.data(model.index(i, 0), Qt::EditRole).toString();
+                       if (is == s)
+                               break;
+               }
+       } else {
+               // In sorted models, do binary search for s.
+               int l = 0;
+               int r = n - 1;
+               while (r >= l && l < int(n)) {
+                       size_t mid = (r + l) / 2;
+                       QString const & mids
+                       = model.data(model.index(mid, 0),
+                                    Qt::EditRole).toString();
+
+                       // left or right?
+                       // FIXME: is this really the same order that the docstring
+                       // from the CompletionList has?
+                       int c = s.compare(mids, Qt::CaseSensitive);
+                       if (c == 0) {
+                               l = mid;
+                               break;
+                       } else if (l == r) {
+                               l = n;
+                               break;
+                       } else if (c > 0)
+                               // middle is not far enough
+                               l = mid + 1;
+                       else
+                               // middle is too far
+                               r = mid - 1;
+               }
+
+               // loop was left without finding anything
+               if (r < l)
+                       i = n;
+               else
+                       i = l;
+               LASSERT(i <= n, /**/);
        }
 
        // select the first if none was found
@@ -556,25 +805,65 @@ void GuiCompleter::setCurrentCompletion(QString const & s)
 }
 
 
-docstring GuiCompleter::longestUniqueCompletion() const {
+size_t commonPrefix(QString const & s1, QString const & s2)
+{
+       // find common prefix
+       size_t j;
+       size_t n1 = s1.length();
+       size_t n2 = s2.length();
+       for (j = 0; j < n1 && j < n2; ++j) {
+               if (s1.at(j) != s2.at(j))
+                       break;
+       }
+       return j;
+}
+
+
+docstring GuiCompleter::longestUniqueCompletion() const
+{
        QAbstractItemModel const & model = *popup()->model();
-       QString s = currentCompletion();
        size_t n = model.rowCount();
-
-       // iterate through the completions and cut off where s differs
-       for (size_t i = 0; i < n && s.length() > 0; ++i) {
-               QString const & is
-               = model.data(model.index(i, 0), Qt::EditRole).toString();
-
-               // find common prefix
-               size_t j;
-               size_t isn = is.length();
-               size_t sn = s.length();
-               for (j = 0; j < isn && j < sn; ++j) {
-                       if (s.at(j) != is.at(j))
-                               break;
+       if (n == 0)
+               return docstring();
+       QString s = model.data(model.index(0, 0), Qt::EditRole).toString();
+       
+       if (modelSorting() == QCompleter::UnsortedModel) {
+               // For unsorted model we cannot do more than iteration.
+               // Iterate through the completions and cut off where s differs
+               for (size_t i = 0; i < n && s.length() > 0; ++i) {
+                       QString const & is
+                       = model.data(model.index(i, 0), Qt::EditRole).toString();
+
+                       s = s.left(commonPrefix(is, s));
+               }
+       } else {
+               // For sorted models we can do binary search multiple times,
+               // each time to find the first string which has s not as prefix.
+               size_t i = 0;
+               while (i < n && s.length() > 0) {
+                       // find first string that does not have s as prefix
+                       // via binary search in [i,n-1]
+                       size_t r = n - 1;
+                       do {
+                               // get common prefix with the middle string
+                               size_t mid = (r + i) / 2;
+                               QString const & mids
+                               = model.data(model.index(mid, 0), 
+                                       Qt::EditRole).toString();
+                               size_t oldLen = s.length();
+                               size_t len = commonPrefix(mids, s);
+                               s = s.left(len);
+
+                               // left or right?
+                               if (oldLen == len) {
+                                       // middle is not far enough
+                                       i = mid + 1;
+                               } else {
+                                       // middle is maybe too far
+                                       r = mid;
+                               }
+                       } while (r - i > 0 && i < n);
                }
-               s = s.left(j);
        }
 
        return from_utf8(fromqstr(s));
@@ -589,7 +878,8 @@ void GuiCompleter::popupActivated(const QString & completion)
        docstring prefix = cur.inset().completionPrefix(cur);
        docstring postfix = from_utf8(fromqstr(completion.mid(prefix.length())));
        cur.inset().insertCompletion(cur, postfix, true);
-       updateVisibility(cur, false);
+       hidePopup(cur);
+       hideInline(cur);
        
        if (cur.disp_.update())
                gui_->bufferView().processUpdateFlags(cur.disp_.update());
@@ -604,7 +894,8 @@ void GuiCompleter::popupHighlighted(const QString & completion)
        Cursor cur = gui_->bufferView().cursor();
        cur.updateFlags(Update::None);
        
-       updateInline(cur, completion);
+       if (inlineVisible())
+               updateInline(cur, completion);
        
        if (cur.disp_.update())
                gui_->bufferView().processUpdateFlags(cur.disp_.update());