src/frontends/qt/GuiCommandBuffer.cpp

   1 /**
   2  * \file GuiCommandBuffer.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars
   7  * \author Asger and Jürgen
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "GuiCommandBuffer.h"
  16
  17 #include "GuiApplication.h"
  18 #include "GuiCommandEdit.h"
  19 #include "GuiView.h"
  20 #include "qt_helpers.h"
  21
  22 #include "BufferView.h"
  23 #include "Cursor.h"
  24 #include "LyX.h"
  25 #include "LyXAction.h"
  26 #include "FuncRequest.h"
  27 #include "Session.h"
  28
  29 #include "support/lstrings.h"
  30
  31 #include <QHBoxLayout>
  32 #include <QKeyEvent>
  33 #include <QListWidget>
  34 #include <QMouseEvent>
  35 #include <QPixmap>
  36 #include <QPushButton>
  37 #include <QToolTip>
  38 #include <QVBoxLayout>
  39
  40 using namespace std;
  41 using namespace lyx::support;
  42
  43 namespace lyx {
  44 namespace frontend {
  45
  46 namespace {
  47
  48 class QTempListBox : public QListWidget {
  49 public:
  50         QTempListBox() {
  51                 //setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
  52                 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
  53                 setWindowModality(Qt::WindowModal);
  54                 setWindowFlags(Qt::Popup);
  55                 setAttribute(Qt::WA_DeleteOnClose);
  56         }
  57 protected:
  58         bool event(QEvent * ev) override {
  59                 if (ev->type() == QEvent::MouseButtonPress) {
  60                         QMouseEvent * me = static_cast<QMouseEvent *>(ev);
  61                         if (me->x() < 0 || me->y() < 0
  62                             || me->x() > width() || me->y() > height())
  63                                 hide();
  64                         return true;
  65                 }
  66                 return QListWidget::event(ev);
  67         }
  68
  69         void keyPressEvent(QKeyEvent * ev) override {
  70                 if (ev->key() == Qt::Key_Escape) {
  71                         hide();
  72                         return;
  73                 } else if (ev->key() == Qt::Key_Return || ev->key() == Qt::Key_Space) {
  74                         // emit signal
  75                         itemClicked(currentItem());
  76                 } else
  77                         QListWidget::keyPressEvent(ev);
  78         }
  79 };
  80
  81 } // namespace
  82
  83
  84 GuiCommandBuffer::GuiCommandBuffer(GuiView * view)
  85         : view_(view)
  86 {
  87         for (auto const & name_code : lyxaction) {
  88                 commands_.push_back(name_code.first);
  89         }
  90
  91         QPixmap qpup = getPixmap("images/", "up", "svgz,png");
  92         QPixmap qpdown = getPixmap("images/", "down", "svgz,png");
  93
  94         QVBoxLayout * top = new QVBoxLayout(this);
  95         QHBoxLayout * layout = new QHBoxLayout(0);
  96
  97         edit_ = new GuiCommandEdit(this);
  98         edit_->setMinimumSize(edit_->sizeHint());
  99         edit_->setFocusPolicy(Qt::ClickFocus);
 100
 101         int height = max(24, 2 * (edit_->sizeHint().height() / 2));
 102         QSize button_size = QSize(height, height);
 103         QSize icon_size = button_size - QSize(4, 4);
 104
 105         upPB = new QPushButton(qpup, "", this);
 106         upPB->setToolTip(qt_("List of previous commands"));
 107         upPB->setMaximumSize(button_size);
 108         upPB->setIconSize(icon_size);
 109         downPB = new QPushButton(qpdown, "", this);
 110         downPB->setToolTip(qt_("Next command"));
 111         downPB->setMaximumSize(button_size);
 112         downPB->setIconSize(icon_size);
 113         downPB->setEnabled(false);
 114         connect(downPB, SIGNAL(clicked()), this, SLOT(down()));
 115         connect(upPB, SIGNAL(pressed()), this, SLOT(listHistoryUp()));
 116
 117         connect(edit_, SIGNAL(returnPressed()), this, SLOT(dispatch()));
 118         connect(edit_, SIGNAL(tabPressed()), this, SLOT(complete()));
 119         connect(edit_, SIGNAL(upPressed()), this, SLOT(up()));
 120         connect(edit_, SIGNAL(downPressed()), this, SLOT(down()));
 121         connect(edit_, SIGNAL(escapePressed()), this, SLOT(hideParent()));
 122
 123         layout->addWidget(upPB, 0);
 124         layout->addWidget(downPB, 0);
 125         layout->addWidget(edit_, 10);
 126         layout->setMargin(0);
 127         top->addLayout(layout);
 128         top->setMargin(0);
 129         setFocusProxy(edit_);
 130
 131         LastCommandsSection::LastCommands last_commands
 132                 = theSession().lastCommands().getcommands();
 133         LastCommandsSection::LastCommands::const_iterator it
 134                 = last_commands.begin();
 135         LastCommandsSection::LastCommands::const_iterator end
 136                 = last_commands.end();
 137
 138         upPB->setEnabled(it != end);
 139
 140         for(; it != end; ++it)
 141                 history_.push_back(*it);
 142         history_pos_ = history_.end();
 143 }
 144
 145
 146 void GuiCommandBuffer::dispatch()
 147 {
 148         std::string const cmd = fromqstr(edit_->text());
 149         if (!cmd.empty())
 150                 theSession().lastCommands().add(cmd);
 151         DispatchResult const & dr = dispatch(cmd);
 152         if (!dr.error()) {
 153                 view_->setFocus();
 154                 edit_->setText(QString());
 155                 edit_->clearFocus();
 156                 // If the toolbar was "auto", it is not needed anymore
 157                 view_->resetCommandExecute();
 158         }
 159 }
 160
 161
 162 void GuiCommandBuffer::listHistoryUp()
 163 {
 164         if (history_.size()==1) {
 165                 edit_->setText(toqstr(history_.back()));
 166                 upPB->setEnabled(false);
 167                 return;
 168         }
 169         QPoint const & pos = upPB->mapToGlobal(QPoint(0, 0));
 170         showList(history_, pos, true);
 171 }
 172
 173
 174 void GuiCommandBuffer::complete()
 175 {
 176         string const input = fromqstr(edit_->text());
 177         string new_input;
 178         vector<string> const & comp = completions(input, new_input);
 179
 180         if (comp.empty()) {
 181                 if (new_input != input)
 182                         edit_->setText(toqstr(new_input));
 183                 return;
 184         }
 185
 186         edit_->setText(toqstr(new_input));
 187         QPoint const & pos = edit_->mapToGlobal(QPoint(0, 0));
 188         showList(comp, pos);
 189 }
 190
 191 void GuiCommandBuffer::showList(vector<string> const & list,
 192         QPoint const & pos, bool reversed) const
 193 {
 194         QTempListBox * listBox = new QTempListBox;
 195
 196         // For some reason the scrollview's contents are larger
 197         // than the number of actual items...
 198         vector<string>::const_iterator cit = list.begin();
 199         vector<string>::const_iterator end = list.end();
 200         for (; cit != end; ++cit) {
 201                 if (reversed)
 202                         listBox->insertItem(0, toqstr(*cit));
 203                 else
 204                         listBox->addItem(toqstr(*cit));
 205         }
 206
 207         listBox->resize(listBox->sizeHint());
 208
 209         int const y = max(0, pos.y() - listBox->height());
 210         listBox->move(pos.x(), y);
 211
 212         connect(listBox, SIGNAL(itemClicked(QListWidgetItem *)),
 213                 this, SLOT(itemSelected(QListWidgetItem *)));
 214         connect(listBox, SIGNAL(itemActivated(QListWidgetItem *)),
 215                 this, SLOT(itemSelected(QListWidgetItem *)));
 216
 217         listBox->show();
 218         listBox->setFocus();
 219 }
 220
 221
 222 void GuiCommandBuffer::itemSelected(QListWidgetItem * item)
 223 {
 224         QWidget const * widget = static_cast<QWidget const *>(sender());
 225         const_cast<QWidget *>(widget)->hide();
 226         edit_->setText(item->text()+ ' ');
 227         edit_->activateWindow();
 228         edit_->setFocus();
 229 }
 230
 231
 232 void GuiCommandBuffer::up()
 233 {
 234         string const h = historyUp();
 235
 236         if (!h.empty())
 237                 edit_->setText(toqstr(h));
 238
 239         upPB->setEnabled(history_pos_ != history_.begin());
 240         downPB->setEnabled(history_pos_ != history_.end());
 241 }
 242
 243
 244 void GuiCommandBuffer::down()
 245 {
 246         string const h = historyDown();
 247
 248         if (!h.empty())
 249                 edit_->setText(toqstr(h));
 250
 251         downPB->setEnabled(!history_.empty()
 252                            && history_pos_ != history_.end() - 1);
 253         upPB->setEnabled(history_pos_ != history_.begin());
 254 }
 255
 256
 257 void GuiCommandBuffer::hideParent()
 258 {
 259         view_->setFocus();
 260         view_->resetCommandExecute();
 261         edit_->setText(QString());
 262         edit_->clearFocus();
 263 }
 264
 265
 266 string const GuiCommandBuffer::historyUp()
 267 {
 268         if (history_pos_ == history_.begin())
 269                 return string();
 270
 271         return *(--history_pos_);
 272 }
 273
 274
 275 string const GuiCommandBuffer::historyDown()
 276 {
 277         if (history_pos_ == history_.end())
 278                 return string();
 279         if (history_pos_ + 1 == history_.end())
 280                 return string();
 281
 282         return *(++history_pos_);
 283 }
 284
 285
 286 vector<string> const
 287 GuiCommandBuffer::completions(string const & prefix, string & new_prefix)
 288 {
 289         vector<string> comp;
 290         for (auto const & cmd : commands_) {
 291                 if (prefixIs(cmd, prefix))
 292                         comp.push_back(cmd);
 293         }
 294
 295         if (comp.empty()) {
 296                 new_prefix = prefix;
 297                 return comp;
 298         }
 299
 300         if (comp.size() == 1) {
 301                 new_prefix = comp[0];
 302                 return vector<string>();
 303         }
 304
 305         // find maximal available prefix
 306         string const tmp = comp[0];
 307         string test = prefix;
 308         if (tmp.length() > test.length())
 309                 test += tmp[test.length()];
 310         while (test.length() < tmp.length()) {
 311                 vector<string> vtmp;
 312                 for (auto const & cmd : comp) {
 313                         if (prefixIs(cmd, test))
 314                                 vtmp.push_back(cmd);
 315                 }
 316                 if (vtmp.size() != comp.size()) {
 317                         test.erase(test.length() - 1);
 318                         break;
 319                 }
 320                 test += tmp[test.length()];
 321         }
 322
 323         new_prefix = test;
 324         return comp;
 325 }
 326
 327
 328 DispatchResult const & GuiCommandBuffer::dispatch(string const & str)
 329 {
 330         if (str.empty()) {
 331                 static DispatchResult empty_dr;
 332                 return empty_dr;
 333         }
 334
 335         history_.push_back(trim(str));
 336         history_pos_ = history_.end();
 337         upPB->setEnabled(history_pos_ != history_.begin());
 338         downPB->setEnabled(history_pos_ != history_.end());
 339         FuncRequest func = lyxaction.lookupFunc(str);
 340         func.setOrigin(FuncRequest::COMMANDBUFFER);
 341         return lyx::dispatch(func);
 342 }
 343
 344 } // namespace frontend
 345 } // namespace lyx
 346
 347 #include "moc_GuiCommandBuffer.cpp"