src/frontends/qt/TocWidget.cpp

   1 /**
   2  * \file TocWidget.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "TocWidget.h"
  15
  16 #include "GuiApplication.h"
  17 #include "GuiView.h"
  18 #include "qt_helpers.h"
  19 #include "TocModel.h"
  20 #include "FancyLineEdit.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferView.h"
  24 #include "Cursor.h"
  25 #include "CutAndPaste.h"
  26 #include "FuncRequest.h"
  27 #include "FuncStatus.h"
  28 #include "LyX.h"
  29 #include "Menus.h"
  30 #include "TocBackend.h"
  31
  32 #include "insets/InsetCommand.h"
  33 #include "insets/InsetRef.h"
  34
  35 #include "support/debug.h"
  36 #include "support/lassert.h"
  37
  38 #include <QHeaderView>
  39 #include <QMenu>
  40 #include <QTimer>
  41
  42 #include <vector>
  43
  44 using namespace std;
  45
  46 namespace lyx {
  47 namespace frontend {
  48
  49 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
  50         : QWidget(parent), depth_(0), persistent_(false), keep_expanded_(false),
  51           gui_view_(gui_view), timer_(new QTimer(this))
  52 {
  53         setupUi(this);
  54
  55         moveOutTB->setIcon(QIcon(getPixmap("images/", "outline-out", "svgz,png")));
  56         moveInTB->setIcon(QIcon(getPixmap("images/", "outline-in", "svgz,png")));
  57         moveUpTB->setIcon(QIcon(getPixmap("images/", "outline-up", "svgz,png")));
  58         moveDownTB->setIcon(QIcon(getPixmap("images/", "outline-down", "svgz,png")));
  59         updateTB->setIcon(QIcon(getPixmap("images/", "reload", "svgz,png")));
  60
  61         QSize icon_size = gui_view.iconSize();
  62         moveOutTB->setIconSize(icon_size);
  63         moveInTB->setIconSize(icon_size);
  64         moveUpTB->setIconSize(icon_size);
  65         moveDownTB->setIconSize(icon_size);
  66         updateTB->setIconSize(icon_size);
  67
  68         // avoid flickering
  69         tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
  70
  71         tocTV->showColumn(0);
  72
  73         // hide the pointless QHeader for now
  74         // in the future, new columns may appear
  75         // like labels, bookmarks, etc...
  76         // tocTV->header()->hide();
  77         tocTV->header()->setVisible(false);
  78
  79         // Only one item selected at a time.
  80         tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
  81
  82         // The toc types combo won't change its model.
  83         typeCO->setModel(gui_view_.tocModels().nameModel());
  84
  85         // The filter bar
  86         filter_ = new FancyLineEdit(this);
  87         filter_->setClearButton(true);
  88         filter_->setPlaceholderText(qt_("All items"));
  89         filterBarL->addWidget(filter_, 0);
  90         filterLA->setBuddy(filter_);
  91         setFocusProxy(filter_);
  92
  93         // Make sure the buttons are disabled when first shown without a loaded
  94         // Buffer.
  95         enableControls(false);
  96
  97         // make us responsible for the context menu of the tabbar
  98         setContextMenuPolicy(Qt::CustomContextMenu);
  99         connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
 100                 this, SLOT(showContextMenu(const QPoint &)));
 101         connect(tocTV, SIGNAL(customContextMenuRequested(const QPoint &)),
 102                 this, SLOT(showContextMenu(const QPoint &)));
 103         connect(filter_, SIGNAL(textEdited(QString)),
 104                 this, SLOT(filterContents()));
 105         connect(filter_, &FancyLineEdit::downPressed,
 106                 tocTV, [this](){ focusAndHighlight(tocTV); });
 107         connect(activeFilterCO, SIGNAL(activated(int)),
 108                 this, SLOT(filterContents()));
 109
 110         // setting the update timer
 111         timer_->setSingleShot(true);
 112         connect(timer_, SIGNAL(timeout()), this, SLOT(finishUpdateView()));
 113
 114         init(QString());
 115 }
 116
 117
 118 void TocWidget::showContextMenu(const QPoint & pos)
 119 {
 120         std::string name = "context-toc-" + fromqstr(current_type_);
 121         QMenu * menu = guiApp->menus().menu(toqstr(name), gui_view_);
 122         if (!menu)
 123                 return;
 124         menu->exec(mapToGlobal(pos));
 125 }
 126
 127
 128 Inset * TocWidget::itemInset() const
 129 {
 130         QModelIndex const & index = tocTV->currentIndex();
 131         TocItem const & item =
 132                 gui_view_.tocModels().currentItem(current_type_, index);
 133         DocIterator const & dit = item.dit();
 134
 135         Inset * inset = nullptr;
 136         if (current_type_ == "label"
 137                   || current_type_ == "graphics"
 138                   || current_type_ == "citation"
 139                   || current_type_ == "child")
 140                 inset = dit.nextInset();
 141
 142         else if (current_type_ == "branch"
 143                          || current_type_ == "index"
 144                          || current_type_ == "change"
 145                          || current_type_ == "table"
 146                      || current_type_ == "listing"
 147                      || current_type_ == "figure")
 148                 inset = &dit.inset();
 149
 150         return inset;
 151 }
 152
 153
 154 bool TocWidget::getStatus(Cursor & cur, FuncRequest const & cmd,
 155         FuncStatus & status) const
 156 {
 157         Inset * inset = itemInset();
 158         FuncRequest tmpcmd(cmd);
 159
 160         QModelIndex const & index = tocTV->currentIndex();
 161         TocItem const & item =
 162                 gui_view_.tocModels().currentItem(current_type_, index);
 163
 164         switch (cmd.action())
 165         {
 166         case LFUN_CHANGE_ACCEPT:
 167         case LFUN_CHANGE_REJECT:
 168         case LFUN_OUTLINE_UP:
 169         case LFUN_OUTLINE_DOWN:
 170         case LFUN_OUTLINE_IN:
 171         case LFUN_OUTLINE_OUT:
 172         case LFUN_SECTION_SELECT:
 173                 status.setEnabled((bool)item.dit());
 174                 return true;
 175
 176         case LFUN_LABEL_COPY_AS_REFERENCE: {
 177                 // For labels in math, we need to supply the label as a string
 178                 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.str());
 179                 if (inset)
 180                         return inset->getStatus(cur, label_copy, status);
 181                 break;
 182         }
 183
 184         default:
 185                 if (inset)
 186                         return inset->getStatus(cur, tmpcmd, status);
 187         }
 188
 189         return false;
 190 }
 191
 192
 193 void TocWidget::doDispatch(Cursor & cur, FuncRequest const & cmd,
 194                 DispatchResult & dr)
 195 {
 196
 197         Inset * inset = itemInset();
 198
 199         QModelIndex const & index = tocTV->currentIndex();
 200         TocItem const & item =
 201                 gui_view_.tocModels().currentItem(current_type_, index);
 202
 203         // Start an undo group.
 204         cur.beginUndoGroup();
 205
 206         switch (cmd.action())
 207         {
 208         case LFUN_CHANGE_ACCEPT:
 209         case LFUN_CHANGE_REJECT: {
 210                 // The action is almost always LYX_UNKNOWN_ACTION, which will
 211                 // have the effect of moving the cursor to the location of
 212                 // the change. (See TocItem::action.)
 213                 dispatch(item.action());
 214                 // If we do not reset the origin, then the request will be sent back
 215                 // here, and we are in an infinite loop. But we need the dispatch
 216                 // machinery to clean up for us, if the cursor is in an inset that
 217                 // will be deleted. See bug #10316.
 218                 FuncRequest tmpcmd(cmd);
 219                 tmpcmd.setOrigin(FuncRequest::INTERNAL);
 220                 dispatch(tmpcmd);
 221                 dr.forceBufferUpdate();
 222                 break;
 223         }
 224
 225         case LFUN_SECTION_SELECT:
 226                 dispatch(item.action());
 227                 cur.dispatch(cmd);
 228                 // necessary to get the selection drawn.
 229                 cur.buffer()->changed(true);
 230                 gui_view_.setFocus();
 231                 break;
 232
 233         case LFUN_LABEL_COPY_AS_REFERENCE: {
 234                 // For labels in math, we need to supply the label as a string
 235                 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.str());
 236                 if (inset)
 237                         inset->dispatch(cur, label_copy);
 238                 break;
 239         }
 240
 241         case LFUN_OUTLINE_UP:
 242         case LFUN_OUTLINE_DOWN:
 243         case LFUN_OUTLINE_IN:
 244         case LFUN_OUTLINE_OUT:
 245                 outline(cmd.action());
 246                 break;
 247
 248         default: {
 249                 FuncRequest tmpcmd(cmd);
 250                 if (inset)
 251                         inset->dispatch(cur, tmpcmd);
 252         }
 253         }
 254         cur.endUndoGroup();
 255 }
 256
 257
 258 void TocWidget::on_tocTV_activated(QModelIndex const & index)
 259 {
 260         goTo(index);
 261 }
 262
 263
 264 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
 265 {
 266         DocIterator const & dit = gui_view_.documentBufferView()->cursor();
 267         keep_expanded_ = gui_view_.tocModels().currentIndex(current_type_, dit) == index;
 268         Qt::MouseButtons const button = QApplication::mouseButtons();
 269         if (button & Qt::LeftButton) {
 270                 goTo(index);
 271                 gui_view_.setFocus();
 272                 gui_view_.activateWindow();
 273         }
 274 }
 275
 276
 277 void TocWidget::on_tocTV_doubleClicked(QModelIndex const &)
 278 {
 279         keep_expanded_ = true;
 280 }
 281
 282
 283 void TocWidget::goTo(QModelIndex const & index)
 284 {
 285         LYXERR(Debug::GUI, "goto " << index.row()
 286                 << ", " << index.column());
 287
 288         sendDispatch(gui_view_.tocModels().goTo(current_type_, index));
 289 }
 290
 291
 292 void TocWidget::on_updateTB_clicked()
 293 {
 294         // The backend update can take some time so we disable
 295         // the controls while waiting.
 296         enableControls(false);
 297         gui_view_.currentBufferView()->buffer().updateBuffer();
 298 }
 299
 300
 301 void TocWidget::on_sortCB_stateChanged(int state)
 302 {
 303         gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
 304         updateViewNow();
 305 }
 306
 307
 308 void TocWidget::on_persistentCB_stateChanged(int state)
 309 {
 310         persistent_ = state == Qt::Checked;
 311 }
 312
 313
 314 #if 0
 315 /* FIXME (Ugras 17/11/06):
 316 I have implemented a indexDepth function to get the model indices. In my
 317 opinion, somebody should derive a new qvariant class for tocModelItem
 318 which saves the string data and depth information. That will save the
 319 depth calculation.  */
 320
 321 static int indexDepth(QModelIndex const & index, int depth = -1)
 322 {
 323         ++depth;
 324         return index.parent() == QModelIndex()
 325                 ? depth : indexDepth(index.parent(), depth);
 326 }
 327 #endif
 328
 329 void TocWidget::on_depthSL_valueChanged(int depth)
 330 {
 331         if (depth == depth_)
 332                 return;
 333         setTreeDepth(depth);
 334         gui_view_.setFocus();
 335 }
 336
 337
 338 void TocWidget::setTreeDepth(int depth)
 339 {
 340         depth_ = depth;
 341         if (!tocTV->model())
 342                 return;
 343
 344         if (depth == 0)
 345                 tocTV->collapseAll();
 346         else
 347                 tocTV->expandToDepth(depth - 1);
 348 }
 349
 350
 351 void TocWidget::on_typeCO_activated(int index)
 352 {
 353         if (index == -1)
 354                 return;
 355         current_type_ = typeCO->itemData(index).toString();
 356         updateViewNow();
 357         if (typeCO->hasFocus())
 358                 gui_view_.setFocus();
 359 }
 360
 361
 362 void TocWidget::outline(FuncCode func_code)
 363 {
 364         QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
 365         if (list.isEmpty())
 366                 return;
 367
 368         //if another window is active, this attempt will fail,
 369         //but it will work at least for the second attempt
 370         gui_view_.activateWindow();
 371
 372         enableControls(false);
 373         goTo(list[0]);
 374         sendDispatch(FuncRequest(func_code));
 375         enableControls(true);
 376         gui_view_.setFocus();
 377 }
 378
 379
 380 void TocWidget::sendDispatch(FuncRequest fr)
 381 {
 382
 383         fr.setViewOrigin(&gui_view_);
 384         GuiWorkArea * old_wa = gui_view_.currentWorkArea();
 385         GuiWorkArea * doc_wa = gui_view_.currentMainWorkArea();
 386         /* The ToC command should be dispatched to the document work area,
 387          * not the Adv. Find&Replace (which is the only other know
 388          * possibility.
 389          */
 390         if (doc_wa != nullptr && doc_wa != old_wa)
 391                 gui_view_.setCurrentWorkArea(doc_wa);
 392         DispatchResult const & dr = dispatch(fr);
 393         /* If the current workarea has not explicitely changed, and the
 394          * original one is still visible, let's reset it.
 395          */
 396         if (gui_view_.currentWorkArea() == doc_wa
 397              && gui_view_.hasVisibleWorkArea(old_wa)
 398              && doc_wa != old_wa)
 399                 gui_view_.setCurrentWorkArea(old_wa);
 400         if (dr.error())
 401                 gui_view_.message(dr.message());
 402 }
 403
 404
 405 void TocWidget::on_moveUpTB_clicked()
 406 {
 407         outline(LFUN_OUTLINE_UP);
 408 }
 409
 410
 411 void TocWidget::on_moveDownTB_clicked()
 412 {
 413         outline(LFUN_OUTLINE_DOWN);
 414 }
 415
 416
 417 void TocWidget::on_moveInTB_clicked()
 418 {
 419         outline(LFUN_OUTLINE_IN);
 420 }
 421
 422
 423 void TocWidget::on_moveOutTB_clicked()
 424 {
 425         outline(LFUN_OUTLINE_OUT);
 426 }
 427
 428
 429 void TocWidget::select(QModelIndex const & index)
 430 {
 431         if (!index.isValid()) {
 432                 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
 433                 return;
 434         }
 435
 436         tocTV->scrollTo(index);
 437         tocTV->clearSelection();
 438         tocTV->setCurrentIndex(index);
 439 }
 440
 441
 442 void TocWidget::enableControls(bool enable)
 443 {
 444         updateTB->setEnabled(enable);
 445
 446         if (!canOutline())
 447                 enable = false;
 448
 449         moveUpTB->setEnabled(enable);
 450         moveDownTB->setEnabled(enable);
 451         moveInTB->setEnabled(enable);
 452         moveOutTB->setEnabled(enable);
 453 }
 454
 455
 456 void TocWidget::updateView()
 457 {
 458         if (!gui_view_.documentBufferView()) {
 459                 tocTV->setModel(nullptr);
 460                 depthSL->setMaximum(0);
 461                 depthSL->setValue(0);
 462                 setEnabled(false);
 463                 return;
 464         }
 465         setEnabled(true);
 466         bool const is_sortable = isSortable();
 467         sortCB->setEnabled(is_sortable);
 468         bool focus = tocTV->hasFocus();
 469         tocTV->setEnabled(false);
 470         tocTV->setUpdatesEnabled(false);
 471
 472         QAbstractItemModel * toc_model =
 473                         gui_view_.tocModels().model(current_type_);
 474         if (tocTV->model() != toc_model) {
 475                 tocTV->setModel(toc_model);
 476                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 477                 if (persistent_)
 478                         setTreeDepth(depth_);
 479         }
 480
 481         sortCB->blockSignals(true);
 482         sortCB->setChecked(is_sortable
 483                 && gui_view_.tocModels().isSorted(current_type_));
 484         sortCB->blockSignals(false);
 485
 486         persistentCB->setEnabled(canNavigate());
 487
 488         bool controls_enabled = toc_model && toc_model->rowCount() > 0
 489                 && !gui_view_.documentBufferView()->buffer().isReadonly();
 490         enableControls(controls_enabled);
 491
 492         depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
 493         depthSL->setValue(depth_);
 494         tocTV->setEnabled(true);
 495         tocTV->setUpdatesEnabled(true);
 496         if (focus)
 497                 tocTV->setFocus();
 498
 499         // Expensive operations are on a timer.  We finish the update immediately
 500         // for sparse edition actions, i.e. there was no edition/cursor movement
 501         // recently, then every 300ms.
 502         if (!timer_->isActive() && !keep_expanded_) {
 503                 finishUpdateView();
 504                 timer_->start(300);
 505         }
 506 }
 507
 508
 509 void TocWidget::updateViewNow()
 510 {
 511         timer_->stop();
 512         updateView();
 513 }
 514
 515
 516 void TocWidget::finishUpdateView()
 517 {
 518         // Profiling shows that this is the expensive stuff in the context of typing
 519         // text and moving with arrows. For bigger operations, this is negligible,
 520         // and outweighted by TocModels::reset() anyway.
 521         if (canNavigate()) {
 522                 if (!persistent_ && !keep_expanded_)
 523                         setTreeDepth(depth_);
 524                 keep_expanded_ = false;
 525                 persistentCB->setChecked(persistent_);
 526                 // select the item at current cursor location
 527                 if (gui_view_.documentBufferView()) {
 528                         DocIterator const & dit = gui_view_.documentBufferView()->cursor();
 529                         select(gui_view_.tocModels().currentIndex(current_type_, dit));
 530                 }
 531         }
 532         filterContents();
 533 }
 534
 535
 536 void TocWidget::filterContents()
 537 {
 538         if (!tocTV->model())
 539                 return;
 540
 541         QModelIndexList indices = tocTV->model()->match(
 542                 tocTV->model()->index(0, 0),
 543                 Qt::DisplayRole, ".*", -1,
 544 #if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
 545                 Qt::MatchFlags(Qt::MatchRegularExpression|Qt::MatchRecursive));
 546 #else
 547                 // deprecated in Qt 5.15.
 548                 Qt::MatchFlags(Qt::MatchRegExp|Qt::MatchRecursive));
 549 #endif
 550
 551         bool const show_active =
 552                 activeFilterCO->currentIndex() != 2;
 553         bool const show_inactive =
 554                 activeFilterCO->currentIndex() != 1;
 555
 556         int size = indices.size();
 557         QString const matchstring = filter_ ? filter_->text() : QString();
 558         for (int i = 0; i < size; i++) {
 559                 QModelIndex index = indices[i];
 560                 bool matches = index.data().toString().contains(
 561                                         matchstring, Qt::CaseInsensitive);
 562                 TocItem const & item =
 563                         gui_view_.tocModels().currentItem(current_type_, index);
 564                 matches &= (show_active && item.isOutput()) || (show_inactive && !item.isOutput());
 565                 tocTV->setRowHidden(index.row(), index.parent(), !matches);
 566         }
 567         // recursively unhide parents of unhidden children
 568         for (int i = size - 1; i >= 0; i--) {
 569                 QModelIndex index = indices[i];
 570                 if (!tocTV->isRowHidden(index.row(), index.parent())
 571                     && index.parent() != QModelIndex())
 572                         tocTV->setRowHidden(index.parent().row(),
 573                                             index.parent().parent(), false);
 574         }
 575 }
 576
 577
 578 static QString decodeType(QString const & str)
 579 {
 580         QString type = str;
 581         if (type.contains("tableofcontents"))
 582                 type = "tableofcontents";
 583         else if (type.contains("lstlistoflistings"))
 584                 type = "listing";
 585         else if (type.contains("floatlist")) {
 586                 if (type.contains("\"figure"))
 587                         type = "figure";
 588                 else if (type.contains("\"table"))
 589                         type = "table";
 590                 else if (type.contains("\"algorithm"))
 591                         type = "algorithm";
 592         }
 593         return type;
 594 }
 595
 596
 597 void TocWidget::init(QString const & str)
 598 {
 599         int new_index;
 600         if (str.isEmpty())
 601                 new_index = typeCO->findData(current_type_);
 602         else
 603                 new_index = typeCO->findData(decodeType(str));
 604
 605         // If everything else fails, settle on the table of contents which is
 606         // guaranteed to exist.
 607         if (new_index == -1) {
 608                 current_type_ = "tableofcontents";
 609                 new_index = typeCO->findData(current_type_);
 610         } else {
 611                 current_type_ = typeCO->itemData(new_index).toString();
 612         }
 613
 614         typeCO->blockSignals(true);
 615         typeCO->setCurrentIndex(new_index);
 616         typeCO->blockSignals(false);
 617         updateViewNow();
 618 }
 619
 620 } // namespace frontend
 621 } // namespace lyx
 622
 623 #include "moc_TocWidget.cpp"