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         Inset * inset = itemInset();
 197
 198         QModelIndex const & index = tocTV->currentIndex();
 199         TocItem const & item =
 200                 gui_view_.tocModels().currentItem(current_type_, index);
 201
 202         // Start an undo group.
 203         cur.beginUndoGroup();
 204
 205         switch (cmd.action())
 206         {
 207         case LFUN_CHANGE_ACCEPT:
 208         case LFUN_CHANGE_REJECT: {
 209                 // The action is almost always LYX_UNKNOWN_ACTION, which will
 210                 // have the effect of moving the cursor to the location of
 211                 // the change. (See TocItem::action.)
 212                 dispatch(item.action());
 213                 // If we do not reset the origin, then the request will be sent back
 214                 // here, and we are in an infinite loop. But we need the dispatch
 215                 // machinery to clean up for us, if the cursor is in an inset that
 216                 // will be deleted. See bug #10316.
 217                 FuncRequest tmpcmd(cmd);
 218                 tmpcmd.setOrigin(FuncRequest::INTERNAL);
 219                 dispatch(tmpcmd);
 220                 dr.forceBufferUpdate();
 221                 break;
 222         }
 223
 224         case LFUN_SECTION_SELECT:
 225                 dispatch(item.action());
 226                 cur.dispatch(cmd);
 227                 // necessary to get the selection drawn.
 228                 cur.buffer()->changed(true);
 229                 gui_view_.setFocus();
 230                 break;
 231
 232         case LFUN_LABEL_COPY_AS_REFERENCE: {
 233                 // For labels in math, we need to supply the label as a string
 234                 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.str());
 235                 if (inset)
 236                         inset->dispatch(cur, label_copy);
 237                 break;
 238         }
 239
 240         case LFUN_OUTLINE_UP:
 241         case LFUN_OUTLINE_DOWN:
 242         case LFUN_OUTLINE_IN:
 243         case LFUN_OUTLINE_OUT:
 244                 outline(cmd.action());
 245                 break;
 246
 247         default: {
 248                 FuncRequest tmpcmd(cmd);
 249                 if (inset)
 250                         inset->dispatch(cur, tmpcmd);
 251         }
 252         }
 253         cur.endUndoGroup();
 254 }
 255
 256
 257 void TocWidget::on_tocTV_activated(QModelIndex const & index)
 258 {
 259         goTo(index);
 260 }
 261
 262
 263 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
 264 {
 265         DocIterator const & dit = gui_view_.documentBufferView()->cursor();
 266         keep_expanded_ = gui_view_.tocModels().currentIndex(current_type_, dit) == index;
 267         Qt::MouseButtons const button = QApplication::mouseButtons();
 268         if (button & Qt::LeftButton) {
 269                 goTo(index);
 270                 gui_view_.setFocus();
 271                 gui_view_.activateWindow();
 272         }
 273 }
 274
 275
 276 void TocWidget::on_tocTV_doubleClicked(QModelIndex const &)
 277 {
 278         keep_expanded_ = true;
 279 }
 280
 281
 282 void TocWidget::goTo(QModelIndex const & index)
 283 {
 284         LYXERR(Debug::GUI, "goto " << index.row()
 285                 << ", " << index.column());
 286
 287         sendDispatch(gui_view_.tocModels().goTo(current_type_, index));
 288 }
 289
 290
 291 void TocWidget::on_updateTB_clicked()
 292 {
 293         // The backend update can take some time so we disable
 294         // the controls while waiting.
 295         enableControls(false);
 296         gui_view_.currentBufferView()->buffer().updateBuffer();
 297 }
 298
 299
 300 void TocWidget::on_sortCB_stateChanged(int state)
 301 {
 302         gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
 303         updateViewNow();
 304 }
 305
 306
 307 void TocWidget::on_persistentCB_stateChanged(int state)
 308 {
 309         persistent_ = state == Qt::Checked;
 310 }
 311
 312
 313 #if 0
 314 /* FIXME (Ugras 17/11/06):
 315 I have implemented a indexDepth function to get the model indices. In my
 316 opinion, somebody should derive a new qvariant class for tocModelItem
 317 which saves the string data and depth information. That will save the
 318 depth calculation.  */
 319
 320 static int indexDepth(QModelIndex const & index, int depth = -1)
 321 {
 322         ++depth;
 323         return index.parent() == QModelIndex()
 324                 ? depth : indexDepth(index.parent(), depth);
 325 }
 326 #endif
 327
 328 void TocWidget::on_depthSL_valueChanged(int depth)
 329 {
 330         if (depth == depth_)
 331                 return;
 332         setTreeDepth(depth);
 333         gui_view_.setFocus();
 334 }
 335
 336
 337 void TocWidget::setTreeDepth(int depth)
 338 {
 339         depth_ = depth;
 340         if (!tocTV->model())
 341                 return;
 342
 343         if (depth == 0)
 344                 tocTV->collapseAll();
 345         else
 346                 tocTV->expandToDepth(depth - 1);
 347 }
 348
 349
 350 void TocWidget::on_typeCO_activated(int index)
 351 {
 352         if (index == -1)
 353                 return;
 354         current_type_ = typeCO->itemData(index).toString();
 355         updateViewNow();
 356         if (typeCO->hasFocus())
 357                 gui_view_.setFocus();
 358 }
 359
 360
 361 void TocWidget::outline(FuncCode func_code)
 362 {
 363         QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
 364         if (list.isEmpty())
 365                 return;
 366
 367         //if another window is active, this attempt will fail,
 368         //but it will work at least for the second attempt
 369         gui_view_.activateWindow();
 370
 371         enableControls(false);
 372         goTo(list[0]);
 373         sendDispatch(FuncRequest(func_code));
 374         enableControls(true);
 375         gui_view_.setFocus();
 376 }
 377
 378
 379 void TocWidget::sendDispatch(FuncRequest fr)
 380 {
 381         fr.setViewOrigin(&gui_view_);
 382         GuiWorkArea * old_wa = gui_view_.currentWorkArea();
 383         GuiWorkArea * doc_wa = gui_view_.currentMainWorkArea();
 384         /* The ToC command should be dispatched to the document work area,
 385          * not the Adv. Find&Replace (which is the only other know
 386          * possibility.
 387          */
 388         if (doc_wa != nullptr && doc_wa != old_wa)
 389                 gui_view_.setCurrentWorkArea(doc_wa);
 390         DispatchResult const & dr = dispatch(fr);
 391         /* If the current workarea has not explicitely changed, and the
 392          * original one is still visible, let's reset it.
 393          */
 394         if (gui_view_.currentWorkArea() == doc_wa
 395              && gui_view_.hasVisibleWorkArea(old_wa)
 396              && doc_wa != old_wa)
 397                 gui_view_.setCurrentWorkArea(old_wa);
 398         if (dr.error())
 399                 gui_view_.message(dr.message());
 400 }
 401
 402
 403 void TocWidget::on_moveUpTB_clicked()
 404 {
 405         outline(LFUN_OUTLINE_UP);
 406 }
 407
 408
 409 void TocWidget::on_moveDownTB_clicked()
 410 {
 411         outline(LFUN_OUTLINE_DOWN);
 412 }
 413
 414
 415 void TocWidget::on_moveInTB_clicked()
 416 {
 417         outline(LFUN_OUTLINE_IN);
 418 }
 419
 420
 421 void TocWidget::on_moveOutTB_clicked()
 422 {
 423         outline(LFUN_OUTLINE_OUT);
 424 }
 425
 426
 427 void TocWidget::select(QModelIndex const & index)
 428 {
 429         if (!index.isValid()) {
 430                 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
 431                 return;
 432         }
 433
 434         tocTV->scrollTo(index);
 435         tocTV->clearSelection();
 436         tocTV->setCurrentIndex(index);
 437 }
 438
 439
 440 void TocWidget::enableControls(bool enable)
 441 {
 442         updateTB->setEnabled(enable);
 443
 444         if (!canOutline())
 445                 enable = false;
 446
 447         moveUpTB->setEnabled(enable);
 448         moveDownTB->setEnabled(enable);
 449         moveInTB->setEnabled(enable);
 450         moveOutTB->setEnabled(enable);
 451 }
 452
 453
 454 void TocWidget::updateView()
 455 {
 456         if (!gui_view_.documentBufferView()) {
 457                 tocTV->setModel(nullptr);
 458                 depthSL->setMaximum(0);
 459                 depthSL->setValue(0);
 460                 setEnabled(false);
 461                 return;
 462         }
 463         setEnabled(true);
 464         bool const is_sortable = isSortable();
 465         sortCB->setEnabled(is_sortable);
 466         bool focus = tocTV->hasFocus();
 467         tocTV->setEnabled(false);
 468         tocTV->setUpdatesEnabled(false);
 469
 470         QAbstractItemModel * toc_model =
 471                         gui_view_.tocModels().model(current_type_);
 472         if (tocTV->model() != toc_model) {
 473                 tocTV->setModel(toc_model);
 474                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 475                 if (persistent_)
 476                         setTreeDepth(depth_);
 477         }
 478
 479         sortCB->blockSignals(true);
 480         sortCB->setChecked(is_sortable
 481                 && gui_view_.tocModels().isSorted(current_type_));
 482         sortCB->blockSignals(false);
 483
 484         persistentCB->setEnabled(canNavigate());
 485
 486         bool controls_enabled = toc_model && toc_model->rowCount() > 0
 487                 && !gui_view_.documentBufferView()->buffer().isReadonly();
 488         enableControls(controls_enabled);
 489
 490         depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
 491         depthSL->setValue(depth_);
 492         tocTV->setEnabled(true);
 493         tocTV->setUpdatesEnabled(true);
 494         if (focus)
 495                 tocTV->setFocus();
 496
 497         // Expensive operations are on a timer.  We finish the update immediately
 498         // for sparse edition actions, i.e. there was no edition/cursor movement
 499         // recently, then every 300ms.
 500         if (!timer_->isActive() && !keep_expanded_) {
 501                 finishUpdateView();
 502                 timer_->start(300);
 503         }
 504         keep_expanded_ = false;
 505 }
 506
 507
 508 void TocWidget::updateViewNow()
 509 {
 510         timer_->stop();
 511         updateView();
 512 }
 513
 514
 515 void TocWidget::finishUpdateView()
 516 {
 517         // Profiling shows that this is the expensive stuff in the context of typing
 518         // text and moving with arrows. For bigger operations, this is negligible,
 519         // and outweighted by TocModels::reset() anyway.
 520         if (canNavigate()) {
 521                 if (!persistent_ && !keep_expanded_)
 522                         setTreeDepth(depth_);
 523                 keep_expanded_ = false;
 524                 persistentCB->setChecked(persistent_);
 525                 // select the item at current cursor location
 526                 if (gui_view_.documentBufferView()) {
 527                         DocIterator const & dit = gui_view_.documentBufferView()->cursor();
 528                         select(gui_view_.tocModels().currentIndex(current_type_, dit));
 529                 }
 530         }
 531         filterContents();
 532 }
 533
 534
 535 void TocWidget::filterContents()
 536 {
 537         if (!tocTV->model())
 538                 return;
 539
 540         QModelIndexList indices = tocTV->model()->match(
 541                 tocTV->model()->index(0, 0),
 542                 Qt::DisplayRole, ".*", -1,
 543 #if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
 544                 Qt::MatchFlags(Qt::MatchRegularExpression|Qt::MatchRecursive));
 545 #else
 546                 // deprecated in Qt 5.15.
 547                 Qt::MatchFlags(Qt::MatchRegExp|Qt::MatchRecursive));
 548 #endif
 549
 550         bool const show_active =
 551                 activeFilterCO->currentIndex() != 2;
 552         bool const show_inactive =
 553                 activeFilterCO->currentIndex() != 1;
 554
 555         int size = indices.size();
 556         QString const matchstring = filter_ ? filter_->text() : QString();
 557         for (int i = 0; i < size; i++) {
 558                 QModelIndex index = indices[i];
 559                 bool matches = index.data().toString().contains(
 560                                         matchstring, Qt::CaseInsensitive);
 561                 TocItem const & item =
 562                         gui_view_.tocModels().currentItem(current_type_, index);
 563                 matches &= (show_active && item.isOutput()) || (show_inactive && !item.isOutput());
 564                 tocTV->setRowHidden(index.row(), index.parent(), !matches);
 565         }
 566         // recursively unhide parents of unhidden children
 567         for (int i = size - 1; i >= 0; i--) {
 568                 QModelIndex index = indices[i];
 569                 if (!tocTV->isRowHidden(index.row(), index.parent())
 570                     && index.parent() != QModelIndex())
 571                         tocTV->setRowHidden(index.parent().row(),
 572                                             index.parent().parent(), false);
 573         }
 574 }
 575
 576
 577 static QString decodeType(QString const & str)
 578 {
 579         QString type = str;
 580         if (type.contains("tableofcontents"))
 581                 type = "tableofcontents";
 582         else if (type.contains("lstlistoflistings"))
 583                 type = "listing";
 584         else if (type.contains("floatlist")) {
 585                 if (type.contains("\"figure"))
 586                         type = "figure";
 587                 else if (type.contains("\"table"))
 588                         type = "table";
 589                 else if (type.contains("\"algorithm"))
 590                         type = "algorithm";
 591         }
 592         return type;
 593 }
 594
 595
 596 void TocWidget::init(QString const & str)
 597 {
 598         int new_index;
 599         if (str.isEmpty())
 600                 new_index = typeCO->findData(current_type_);
 601         else
 602                 new_index = typeCO->findData(decodeType(str));
 603
 604         // If everything else fails, settle on the table of contents which is
 605         // guaranteed to exist.
 606         if (new_index == -1) {
 607                 current_type_ = "tableofcontents";
 608                 new_index = typeCO->findData(current_type_);
 609         } else {
 610                 current_type_ = typeCO->itemData(new_index).toString();
 611         }
 612
 613         typeCO->blockSignals(true);
 614         typeCO->setCurrentIndex(new_index);
 615         typeCO->blockSignals(false);
 616         updateViewNow();
 617 }
 618
 619 } // namespace frontend
 620 } // namespace lyx
 621
 622 #include "moc_TocWidget.cpp"