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