bookmarkmanager.cpp 26.9 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24 25 26
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

con's avatar
con committed
31
#include "bookmarkmanager.h"
hjk's avatar
hjk committed
32

con's avatar
con committed
33 34 35 36 37
#include "bookmark.h"
#include "bookmarksplugin.h"
#include "bookmarks_global.h"

#include <coreplugin/editormanager/editormanager.h>
38
#include <coreplugin/icore.h>
39
#include <coreplugin/actionmanager/actionmanager.h>
40
#include <coreplugin/actionmanager/command.h>
41
#include <projectexplorer/projectexplorer.h>
42
#include <projectexplorer/session.h>
43
#include <texteditor/texteditor.h>
44 45
#include <utils/tooltip/tooltip.h>
#include <utils/tooltip/tipcontents.h>
hjk's avatar
hjk committed
46
#include <utils/qtcassert.h>
47
#include <utils/checkablemessagebox.h>
con's avatar
con committed
48

49 50
#include <QAction>
#include <QContextMenuEvent>
51
#include <QDebug>
52 53
#include <QDialog>
#include <QDialogButtonBox>
54 55
#include <QDir>
#include <QFileInfo>
56 57
#include <QFormLayout>
#include <QLineEdit>
58 59
#include <QMenu>
#include <QPainter>
60
#include <QSpinBox>
con's avatar
con committed
61 62 63 64

Q_DECLARE_METATYPE(Bookmarks::Internal::Bookmark*)

using namespace ProjectExplorer;
65
using namespace Core;
hjk's avatar
hjk committed
66
using namespace Utils;
con's avatar
con committed
67

68 69 70
namespace Bookmarks {
namespace Internal {

con's avatar
con committed
71
BookmarkDelegate::BookmarkDelegate(QObject *parent)
hjk's avatar
hjk committed
72
    : QStyledItemDelegate(parent)
con's avatar
con committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
{
}

QSize BookmarkDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    QStyleOptionViewItemV4 opt = option;
    initStyleOption(&opt, index);

    QFontMetrics fm(option.font);
    QSize s;
    s.setWidth(option.rect.width());
    s.setHeight(fm.height() * 2 + 10);
    return s;
}

88
void BookmarkDelegate::generateGradientPixmap(int width, int height, const QColor &color, bool selected) const
con's avatar
con committed
89 90 91 92
{
    QColor c = color;
    c.setAlpha(0);

hjk's avatar
hjk committed
93 94
    QPixmap pixmap(width+1, height);
    pixmap.fill(c);
con's avatar
con committed
95

hjk's avatar
hjk committed
96
    QPainter painter(&pixmap);
con's avatar
con committed
97 98 99 100 101 102 103 104 105
    painter.setPen(Qt::NoPen);

    QLinearGradient lg;
    lg.setCoordinateMode(QGradient::ObjectBoundingMode);
    lg.setFinalStop(1,0);

    lg.setColorAt(0, c);
    lg.setColorAt(0.4, color);

hjk's avatar
hjk committed
106
    painter.setBrush(lg);
con's avatar
con committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    painter.drawRect(0, 0, width+1, height);

    if (selected)
        m_selectedPixmap = pixmap;
    else
        m_normalPixmap = pixmap;
}

void BookmarkDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    QStyleOptionViewItemV4 opt = option;
    initStyleOption(&opt, index);
    painter->save();

    QFontMetrics fm(opt.font);
122
    static int lwidth = fm.width(QLatin1String("8888")) + 18;
con's avatar
con committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

    QColor backgroundColor;
    QColor textColor;

    bool selected = opt.state & QStyle::State_Selected;

    if (selected) {
        painter->setBrush(opt.palette.highlight().color());
        backgroundColor = opt.palette.highlight().color();
        if (!m_selectedPixmap)
            generateGradientPixmap(lwidth, fm.height()+1, backgroundColor, selected);
    } else {
        painter->setBrush(opt.palette.background().color());
        backgroundColor = opt.palette.background().color();
        if (!m_normalPixmap)
            generateGradientPixmap(lwidth, fm.height(), backgroundColor, selected);
    }
    painter->setPen(Qt::NoPen);
    painter->drawRect(opt.rect);

    // Set Text Color
    if (opt.state & QStyle::State_Selected)
        textColor = opt.palette.highlightedText().color();
    else
        textColor = opt.palette.text().color();

    painter->setPen(textColor);


    // TopLeft
hjk's avatar
hjk committed
153
    QString topLeft = index.data(BookmarkManager::Filename).toString();
con's avatar
con committed
154 155 156
    painter->drawText(6, 2 + opt.rect.top() + fm.ascent(), topLeft);

    QString topRight = index.data(BookmarkManager::LineNumber).toString();
Tobias Hunger's avatar
Tobias Hunger committed
157
    // Check whether we need to be fancy and paint some background
con's avatar
con committed
158 159 160
    int fwidth = fm.width(topLeft);
    if (fwidth + lwidth > opt.rect.width()) {
        int left = opt.rect.right() - lwidth;
hjk's avatar
hjk committed
161
        painter->drawPixmap(left, opt.rect.top(), selected ? m_selectedPixmap : m_normalPixmap);
con's avatar
con committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    }
    // topRight
    painter->drawText(opt.rect.right() - fm.width(topRight) - 6 , 2 + opt.rect.top() + fm.ascent(), topRight);

    // Directory
    QColor mix;
    mix.setRgbF(0.7 * textColor.redF()   + 0.3 * backgroundColor.redF(),
                0.7 * textColor.greenF() + 0.3 * backgroundColor.greenF(),
                0.7 * textColor.blueF()  + 0.3 * backgroundColor.blueF());
    painter->setPen(mix);
//
//    QString directory = index.data(BookmarkManager::Directory).toString();
//    int availableSpace = opt.rect.width() - 12;
//    if (fm.width(directory) > availableSpace) {
//        // We need a shorter directory
//        availableSpace -= fm.width("...");
//
//        int pos = directory.size();
//        int idx;
//        forever {
//            idx = directory.lastIndexOf("/", pos-1);
hjk's avatar
hjk committed
183
//            if (idx == -1) {
con's avatar
con committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
//                // Can't happen, this means the string did fit after all?
//                break;
//            }
//            int width = fm.width(directory.mid(idx, pos-idx));
//            if (width > availableSpace) {
//                directory = "..." + directory.mid(pos);
//                break;
//            } else {
//                pos = idx;
//                availableSpace -= width;
//            }
//        }
//    }
//
//    painter->drawText(3, opt.rect.top() + fm.ascent() + fm.height() + 6, directory);

Orgad Shaneh's avatar
Orgad Shaneh committed
200 201 202
    QString lineText = index.data(BookmarkManager::Note).toString().trimmed();
    if (lineText.isEmpty())
        lineText = index.data(BookmarkManager::LineText).toString().trimmed();
203

Orgad Shaneh's avatar
Orgad Shaneh committed
204
    painter->drawText(6, opt.rect.top() + fm.ascent() + fm.height() + 6, lineText);
con's avatar
con committed
205 206 207 208 209 210 211

    // Separator lines
    painter->setPen(QColor::fromRgb(150,150,150));
    painter->drawLine(0, opt.rect.bottom(), opt.rect.right(), opt.rect.bottom());
    painter->restore();
}

hjk's avatar
hjk committed
212 213 214
BookmarkView::BookmarkView(BookmarkManager *manager)  :
    m_bookmarkContext(new Core::IContext(this)),
    m_manager(manager)
con's avatar
con committed
215 216 217
{
    setWindowTitle(tr("Bookmarks"));

hjk's avatar
hjk committed
218 219
    m_bookmarkContext->setWidget(this);
    m_bookmarkContext->setContext(Core::Context(Constants::BOOKMARKS_CONTEXT));
con's avatar
con committed
220

hjk's avatar
hjk committed
221
    ICore::addContextObject(m_bookmarkContext);
con's avatar
con committed
222

hjk's avatar
hjk committed
223 224
    Utils::ListView::setModel(manager);

con's avatar
con committed
225 226 227 228
    setItemDelegate(new BookmarkDelegate(this));
    setFrameStyle(QFrame::NoFrame);
    setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    setFocusPolicy(Qt::NoFocus);
hjk's avatar
hjk committed
229 230 231
    setSelectionModel(manager->selectionModel());
    setSelectionMode(QAbstractItemView::SingleSelection);
    setSelectionBehavior(QAbstractItemView::SelectRows);
232 233
    setDragEnabled(true);
    setDragDropMode(QAbstractItemView::DragOnly);
hjk's avatar
hjk committed
234

hjk's avatar
hjk committed
235 236
    connect(this, &QAbstractItemView::clicked, this, &BookmarkView::gotoBookmark);
    connect(this, &QAbstractItemView::activated, this, &BookmarkView::gotoBookmark);
con's avatar
con committed
237 238 239 240
}

BookmarkView::~BookmarkView()
{
hjk's avatar
hjk committed
241
    ICore::removeContextObject(m_bookmarkContext);
con's avatar
con committed
242 243 244 245 246
}

void BookmarkView::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu menu;
247 248
    QAction *moveUp = menu.addAction(tr("Move Up"));
    QAction *moveDown = menu.addAction(tr("Move Down"));
249
    QAction *edit = menu.addAction(tr("&Edit"));
250
    menu.addSeparator();
251
    QAction *remove = menu.addAction(tr("&Remove"));
252
    menu.addSeparator();
253
    QAction *removeAll = menu.addAction(tr("Remove All"));
254

con's avatar
con committed
255
    m_contextMenuIndex = indexAt(event->pos());
256 257 258
    if (!m_contextMenuIndex.isValid()) {
        moveUp->setEnabled(false);
        moveDown->setEnabled(false);
con's avatar
con committed
259
        remove->setEnabled(false);
260
        edit->setEnabled(false);
261
    }
con's avatar
con committed
262 263 264 265

    if (model()->rowCount() == 0)
        removeAll->setEnabled(false);

hjk's avatar
hjk committed
266 267 268 269 270
    connect(moveUp, &QAction::triggered, m_manager, &BookmarkManager::moveUp);
    connect(moveDown, &QAction::triggered, m_manager, &BookmarkManager::moveDown);
    connect(remove, &QAction::triggered, this, &BookmarkView::removeFromContextMenu);
    connect(removeAll, &QAction::triggered, this, &BookmarkView::removeAll);
    connect(edit, &QAction::triggered, m_manager, &BookmarkManager::edit);
con's avatar
con committed
271 272 273 274 275 276 277 278 279 280 281

    menu.exec(mapToGlobal(event->pos()));
}

void BookmarkView::removeFromContextMenu()
{
    removeBookmark(m_contextMenuIndex);
}

void BookmarkView::removeBookmark(const QModelIndex& index)
{
282 283
    Bookmark *bm = m_manager->bookmarkForIndex(index);
    m_manager->removeBookmark(bm);
con's avatar
con committed
284 285
}

286 287 288 289 290 291 292
void BookmarkView::keyPressEvent(QKeyEvent *event)
{
    if (event->key() == Qt::Key_Delete) {
        removeBookmark(currentIndex());
        event->accept();
        return;
    }
293
    Utils::ListView::keyPressEvent(event);
294 295
}

con's avatar
con committed
296 297
void BookmarkView::removeAll()
{
298 299 300 301 302 303
    if (Utils::CheckableMessageBox::doNotAskAgainQuestion(this,
            tr("Remove All Bookmarks"),
            tr("Are you sure you want to remove all bookmarks from all files in the current session?"),
            ICore::settings(),
            QLatin1String("RemoveAllBookmarks")) != QDialogButtonBox::Yes)
        return;
304 305

    // The performance of this function could be greatly improved.
306 307
    while (m_manager->rowCount()) {
        QModelIndex index = m_manager->index(0, 0);
con's avatar
con committed
308 309 310 311 312 313
        removeBookmark(index);
    }
}

void BookmarkView::gotoBookmark(const QModelIndex &index)
{
314 315 316
    Bookmark *bk = m_manager->bookmarkForIndex(index);
    if (!m_manager->gotoBookmark(bk))
        m_manager->removeBookmark(bk);
con's avatar
con committed
317 318 319 320 321 322
}

////
// BookmarkManager
////

323 324 325
BookmarkManager::BookmarkManager() :
    m_bookmarkIcon(QLatin1String(":/bookmarks/images/bookmark.png")),
    m_selectionModel(new QItemSelectionModel(this, this))
con's avatar
con committed
326
{
hjk's avatar
hjk committed
327 328
    connect(Core::ICore::instance(), &ICore::contextChanged,
            this, &BookmarkManager::updateActionStatus);
con's avatar
con committed
329

hjk's avatar
hjk committed
330 331
    connect(SessionManager::instance(), &SessionManager::sessionLoaded,
            this, &BookmarkManager::loadBookmarks);
con's avatar
con committed
332 333 334 335 336 337 338 339 340 341

    updateActionStatus();
}

BookmarkManager::~BookmarkManager()
{
    DirectoryFileBookmarksMap::iterator it, end;
    end = m_bookmarksMap.end();
    for (it = m_bookmarksMap.begin(); it != end; ++it) {
        FileNameBookmarksMap *bookmarks = it.value();
con's avatar
con committed
342
        qDeleteAll(*bookmarks);
con's avatar
con committed
343 344 345 346 347 348 349 350 351
        delete bookmarks;
    }
}

QItemSelectionModel *BookmarkManager::selectionModel() const
{
    return m_selectionModel;
}

352 353
bool BookmarkManager::hasBookmarkInPosition(const QString &fileName, int lineNumber)
{
hjk's avatar
hjk committed
354
    return findBookmark(fileName, lineNumber);
355 356
}

con's avatar
con committed
357 358 359 360 361
QModelIndex BookmarkManager::index(int row, int column, const QModelIndex &parent) const
{
    if (parent.isValid())
        return QModelIndex();
    else
362
        return createIndex(row, column);
con's avatar
con committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
}

QModelIndex BookmarkManager::parent(const QModelIndex &) const
{
    return QModelIndex();
}

int BookmarkManager::rowCount(const QModelIndex &parent) const
{
    if (parent.isValid())
        return 0;
    else
        return m_bookmarksList.count();
}

int BookmarkManager::columnCount(const QModelIndex &parent) const
{
    if (parent.isValid())
        return 0;
    return 3;
}

QVariant BookmarkManager::data(const QModelIndex &index, int role) const
{
    if (!index.isValid() || index.column() !=0 || index.row() < 0 || index.row() >= m_bookmarksList.count())
        return QVariant();

hjk's avatar
hjk committed
390
    Bookmark *bookMark = m_bookmarksList.at(index.row());
con's avatar
con committed
391
    if (role == BookmarkManager::Filename)
hjk's avatar
hjk committed
392
        return QFileInfo(bookMark->fileName()).fileName();
hjk's avatar
hjk committed
393
    if (role == BookmarkManager::LineNumber)
hjk's avatar
hjk committed
394
        return bookMark->lineNumber();
hjk's avatar
hjk committed
395
    if (role == BookmarkManager::Directory)
hjk's avatar
hjk committed
396
        return QFileInfo(bookMark->fileName()).path();
hjk's avatar
hjk committed
397
    if (role == BookmarkManager::LineText)
hjk's avatar
hjk committed
398
        return bookMark->lineText();
hjk's avatar
hjk committed
399
    if (role == BookmarkManager::Note)
hjk's avatar
hjk committed
400
        return bookMark->note();
hjk's avatar
hjk committed
401
    if (role == Qt::ToolTipRole)
hjk's avatar
hjk committed
402
        return QDir::toNativeSeparators(bookMark->fileName());
con's avatar
con committed
403 404 405
    return QVariant();
}

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
Qt::ItemFlags BookmarkManager::flags(const QModelIndex &index) const
{
    if (!index.isValid() || index.column() !=0 || index.row() < 0 || index.row() >= m_bookmarksList.count())
        return Qt::NoItemFlags;
    return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsDragEnabled;
}

Qt::DropActions BookmarkManager::supportedDragActions() const
{
    return Qt::MoveAction;
}

QStringList BookmarkManager::mimeTypes() const
{
    return FileDropSupport::mimeTypesForFilePaths();
}

QMimeData *BookmarkManager::mimeData(const QModelIndexList &indexes) const
{
    auto data = new Utils::FileDropMimeData;
    foreach (const QModelIndex &index, indexes) {
        if (!index.isValid() || index.column() != 0 || index.row() < 0 || index.row() >= m_bookmarksList.count())
            continue;
        Bookmark *bookMark = m_bookmarksList.at(index.row());
        data->addFile(bookMark->fileName(), bookMark->lineNumber());
    }
    return data;
}

hjk's avatar
hjk committed
435
void BookmarkManager::toggleBookmark(bool)
con's avatar
con committed
436
{
hjk's avatar
hjk committed
437
    IEditor *editor = EditorManager::currentEditor();
con's avatar
con committed
438 439 440
    if (!editor)
        return;

441
    toggleBookmark(editor->document()->filePath(), editor->currentLine());
hjk's avatar
hjk committed
442 443 444 445
}

void BookmarkManager::toggleBookmark(const QString &fileName, int lineNumber)
{
hjk's avatar
hjk committed
446 447
    if (lineNumber <= 0)
        return;
con's avatar
con committed
448 449

    // Remove any existing bookmark on this line
hjk's avatar
hjk committed
450
    if (Bookmark *mark = findBookmark(fileName, lineNumber)) {
con's avatar
con committed
451 452 453 454 455 456
        // TODO check if the bookmark is really on the same markable Interface
        removeBookmark(mark);
        return;
    }

    // Add a new bookmark if no bookmark existed on this line
hjk's avatar
hjk committed
457 458 459
    Bookmark *mark = new Bookmark(lineNumber, this);
    mark->updateFileName(fileName);
    addBookmark(mark);
con's avatar
con committed
460 461 462 463
}

void BookmarkManager::updateBookmark(Bookmark *bookmark)
{
464 465 466 467
    const int idx = m_bookmarksList.indexOf(bookmark);
    if (idx == -1)
        return;

con's avatar
con committed
468 469 470 471
    emit dataChanged(index(idx, 0, QModelIndex()), index(idx, 2, QModelIndex()));
    saveBookmarks();
}

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
void BookmarkManager::removeAllBookmarks()
{
    if (m_bookmarksList.isEmpty())
        return;
    beginRemoveRows(QModelIndex(), 0, m_bookmarksList.size() - 1);

    DirectoryFileBookmarksMap::const_iterator it, end;
    end = m_bookmarksMap.constEnd();
    for (it = m_bookmarksMap.constBegin(); it != end; ++it) {
        FileNameBookmarksMap *files = it.value();
        FileNameBookmarksMap::const_iterator jt, jend;
        jend = files->constEnd();
        for (jt = files->constBegin(); jt != jend; ++jt) {
            delete jt.value();
        }
        files->clear();
        delete files;
    }
    m_bookmarksMap.clear();
    m_bookmarksList.clear();
    endRemoveRows();
}

con's avatar
con committed
495 496
void BookmarkManager::removeBookmark(Bookmark *bookmark)
{
497 498 499
    int idx = m_bookmarksList.indexOf(bookmark);
    beginRemoveRows(QModelIndex(), idx, idx);

hjk's avatar
hjk committed
500
    const QFileInfo fi(bookmark->fileName());
con's avatar
con committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
    FileNameBookmarksMap *files = m_bookmarksMap.value(fi.path());

    FileNameBookmarksMap::iterator i = files->begin();
    while (i != files->end()) {
        if (i.value() == bookmark) {
            files->erase(i);
            delete bookmark;
            break;
        }
        ++i;
    }
    if (files->count() <= 0) {
        m_bookmarksMap.remove(fi.path());
        delete files;
    }

517

con's avatar
con committed
518 519 520 521 522 523 524 525 526 527
    m_bookmarksList.removeAt(idx);
    endRemoveRows();

    if (selectionModel()->currentIndex().isValid())
        selectionModel()->setCurrentIndex(selectionModel()->currentIndex(), QItemSelectionModel::Select | QItemSelectionModel::Clear);

    updateActionStatus();
    saveBookmarks();
}

hjk's avatar
hjk committed
528
Bookmark *BookmarkManager::bookmarkForIndex(const QModelIndex &index) const
con's avatar
con committed
529 530 531 532 533 534
{
    if (!index.isValid() || index.row() >= m_bookmarksList.size())
        return 0;
    return m_bookmarksList.at(index.row());
}

hjk's avatar
hjk committed
535
bool BookmarkManager::gotoBookmark(Bookmark *bookmark)
con's avatar
con committed
536
{
hjk's avatar
hjk committed
537
    if (IEditor *editor = EditorManager::openEditorAt(bookmark->fileName(), bookmark->lineNumber()))
hjk's avatar
hjk committed
538
        return editor->currentLine() == bookmark->lineNumber();
539
    return false;
con's avatar
con committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553
}

void BookmarkManager::nextInDocument()
{
    documentPrevNext(true);
}

void BookmarkManager::prevInDocument()
{
    documentPrevNext(false);
}

void BookmarkManager::documentPrevNext(bool next)
{
hjk's avatar
hjk committed
554 555 556 557 558
    IEditor *editor = EditorManager::currentEditor();
    const int editorLine = editor->currentLine();
    if (editorLine <= 0)
        return;

559
    QFileInfo fi(editor->document()->filePath());
con's avatar
con committed
560 561 562 563 564 565 566
    if (!m_bookmarksMap.contains(fi.path()))
        return;

    int firstLine = -1;
    int lastLine = -1;
    int prevLine = -1;
    int nextLine = -1;
hjk's avatar
hjk committed
567
    const QList<Bookmark *> marks = m_bookmarksMap.value(fi.path())->values(fi.fileName());
con's avatar
con committed
568 569 570 571 572 573 574 575 576 577 578 579 580
    for (int i = 0; i < marks.count(); ++i) {
        int markLine = marks.at(i)->lineNumber();
        if (firstLine == -1 || firstLine > markLine)
            firstLine = markLine;
        if (lastLine < markLine)
            lastLine = markLine;
        if (markLine < editorLine && prevLine < markLine)
            prevLine = markLine;
        if (markLine > editorLine &&
            (nextLine == -1 || nextLine > markLine))
            nextLine = markLine;
    }

581
    EditorManager::addCurrentPositionToNavigationHistory();
con's avatar
con committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
    if (next) {
        if (nextLine == -1)
            editor->gotoLine(firstLine);
        else
            editor->gotoLine(nextLine);
    } else {
        if (prevLine == -1)
            editor->gotoLine(lastLine);
        else
            editor->gotoLine(prevLine);
    }
}

void BookmarkManager::next()
{
    QModelIndex current = selectionModel()->currentIndex();
    if (!current.isValid())
        return;
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
    int row = current.row();
    ++row;
    while (true) {
        if (row == m_bookmarksList.size())
            row = 0;

        Bookmark *bk = m_bookmarksList.at(row);
        if (gotoBookmark(bk)) {
            QModelIndex newIndex = current.sibling(row, current.column());
            selectionModel()->setCurrentIndex(newIndex, QItemSelectionModel::Select | QItemSelectionModel::Clear);
            return;
        }
        removeBookmark(bk);
        if (m_bookmarksList.isEmpty()) // No bookmarks anymore ...
            return;
    }
con's avatar
con committed
616 617 618 619 620 621 622
}

void BookmarkManager::prev()
{
    QModelIndex current = selectionModel()->currentIndex();
    if (!current.isValid())
        return;
623

con's avatar
con committed
624
    int row = current.row();
625 626 627 628 629 630 631 632 633 634 635 636 637 638
    while (true) {
        if (row == 0)
            row = m_bookmarksList.size();
        --row;
        Bookmark *bk = m_bookmarksList.at(row);
        if (gotoBookmark(bk)) {
            QModelIndex newIndex = current.sibling(row, current.column());
            selectionModel()->setCurrentIndex(newIndex, QItemSelectionModel::Select | QItemSelectionModel::Clear);
            return;
        }
        removeBookmark(bk);
        if (m_bookmarksList.isEmpty())
            return;
    }
con's avatar
con committed
639 640 641 642 643 644 645
}

BookmarkManager::State BookmarkManager::state() const
{
    if (m_bookmarksMap.empty())
        return NoBookMarks;

hjk's avatar
hjk committed
646
    IEditor *editor = EditorManager::currentEditor();
con's avatar
con committed
647 648 649
    if (!editor)
        return HasBookMarks;

650
    const QFileInfo fi(editor->document()->filePath());
con's avatar
con committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681

    const DirectoryFileBookmarksMap::const_iterator dit = m_bookmarksMap.constFind(fi.path());
    if (dit == m_bookmarksMap.constEnd())
        return HasBookMarks;

    return HasBookmarksInDocument;
}

void BookmarkManager::updateActionStatus()
{
    emit updateActions(state());
}

void BookmarkManager::moveUp()
{
    QModelIndex current = selectionModel()->currentIndex();
    int row = current.row();
    if (row == 0)
        row = m_bookmarksList.size();
     --row;

    // swap current.row() and row

    Bookmark *b = m_bookmarksList.at(row);
    m_bookmarksList[row] = m_bookmarksList.at(current.row());
    m_bookmarksList[current.row()] = b;

    QModelIndex topLeft = current.sibling(row, 0);
    QModelIndex bottomRight = current.sibling(current.row(), 2);
    emit dataChanged(topLeft, bottomRight);
    selectionModel()->setCurrentIndex(current.sibling(row, 0), QItemSelectionModel::Select | QItemSelectionModel::Clear);
Vasiliy Sorokin's avatar
Vasiliy Sorokin committed
682 683

    saveBookmarks();
con's avatar
con committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
}

void BookmarkManager::moveDown()
{
    QModelIndex current = selectionModel()->currentIndex();
    int row = current.row();
    ++row;
    if (row == m_bookmarksList.size())
        row = 0;

    // swap current.row() and row
    Bookmark *b = m_bookmarksList.at(row);
    m_bookmarksList[row] = m_bookmarksList.at(current.row());
    m_bookmarksList[current.row()] = b;

    QModelIndex topLeft = current.sibling(current.row(), 0);
    QModelIndex bottomRight = current.sibling(row, 2);
    emit dataChanged(topLeft, bottomRight);
    selectionModel()->setCurrentIndex(current.sibling(row, 0), QItemSelectionModel::Select | QItemSelectionModel::Clear);
Vasiliy Sorokin's avatar
Vasiliy Sorokin committed
703 704

    saveBookmarks();
con's avatar
con committed
705 706
}

hjk's avatar
hjk committed
707
void BookmarkManager::editByFileAndLine(const QString &fileName, int lineNumber)
708
{
hjk's avatar
hjk committed
709
    Bookmark *b = findBookmark(fileName, lineNumber);
710 711 712 713
    QModelIndex current = selectionModel()->currentIndex();
    selectionModel()->setCurrentIndex(current.sibling(m_bookmarksList.indexOf(b), 0),
                                      QItemSelectionModel::Select | QItemSelectionModel::Clear);

714
    edit();
715 716
}

717
void BookmarkManager::edit()
718 719 720 721
{
    QModelIndex current = selectionModel()->currentIndex();
    Bookmark *b = m_bookmarksList.at(current.row());

722 723 724 725
    QDialog dlg;
    dlg.setWindowTitle(tr("Edit Bookmark"));
    auto layout = new QFormLayout(&dlg);
    auto noteEdit = new QLineEdit(b->note());
726
    noteEdit->setMinimumWidth(300);
727 728 729
    auto lineNumberSpinbox = new QSpinBox;
    lineNumberSpinbox->setRange(1, INT_MAX);
    lineNumberSpinbox->setValue(b->lineNumber());
730
    lineNumberSpinbox->setMaximumWidth(100);
731
    auto buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
hjk's avatar
hjk committed
732 733
    connect(buttonBox, &QDialogButtonBox::accepted, &dlg, &QDialog::accept);
    connect(buttonBox, &QDialogButtonBox::rejected, &dlg, &QDialog::reject);
734
    layout->addRow(tr("Note text:"), noteEdit);
735
    layout->addRow(tr("Line number:"), lineNumberSpinbox);
736 737
    layout->addWidget(buttonBox);
    if (dlg.exec() == QDialog::Accepted) {
738
        b->move(lineNumberSpinbox->value());
739
        b->updateNote(noteEdit->text().replace(QLatin1Char('\t'), QLatin1Char(' ')));
740
        emit dataChanged(current, current);
Vasiliy Sorokin's avatar
Vasiliy Sorokin committed
741
        saveBookmarks();
742 743 744
    }
}

con's avatar
con committed
745
/* Returns the bookmark at the given file and line number, or 0 if no such bookmark exists. */
hjk's avatar
hjk committed
746
Bookmark *BookmarkManager::findBookmark(const QString &filePath, int lineNumber)
con's avatar
con committed
747
{
hjk's avatar
hjk committed
748 749
    QFileInfo fi(filePath);
    QString path = fi.path();
con's avatar
con committed
750
    if (m_bookmarksMap.contains(path)) {
hjk's avatar
hjk committed
751
        foreach (Bookmark *bookmark, m_bookmarksMap.value(path)->values(fi.fileName())) {
con's avatar
con committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765
            if (bookmark->lineNumber() == lineNumber)
                return bookmark;
        }
    }
    return 0;
}

/* Adds a bookmark to the internal data structures. The 'userset' parameter
 * determines whether action status should be updated and whether the bookmarks
 * should be saved to the session settings.
 */
void BookmarkManager::addBookmark(Bookmark *bookmark, bool userset)
{
    beginInsertRows(QModelIndex(), m_bookmarksList.size(), m_bookmarksList.size());
hjk's avatar
hjk committed
766
    const QFileInfo fi(bookmark->fileName());
con's avatar
con committed
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
    const QString &path = fi.path();

    if (!m_bookmarksMap.contains(path))
        m_bookmarksMap.insert(path, new FileNameBookmarksMap());
    m_bookmarksMap.value(path)->insert(fi.fileName(), bookmark);

    m_bookmarksList.append(bookmark);

    endInsertRows();
    if (userset) {
        updateActionStatus();
        saveBookmarks();
    }
    selectionModel()->setCurrentIndex(index(m_bookmarksList.size()-1 , 0, QModelIndex()), QItemSelectionModel::Select | QItemSelectionModel::Clear);
}

/* Adds a new bookmark based on information parsed from the string. */
void BookmarkManager::addBookmark(const QString &s)
{
786
    // index3 is a frontier beetween note text and other bookmarks data
787
    int index3 = s.lastIndexOf(QLatin1Char('\t'));
788 789
    if (index3 < 0)
        index3 = s.size();
790 791
    int index2 = s.lastIndexOf(QLatin1Char(':'), index3 - 1);
    int index1 = s.indexOf(QLatin1Char(':'));
792 793

    if (index3 != -1 || index2 != -1 || index1 != -1) {
con's avatar
con committed
794
        const QString &filePath = s.mid(index1+1, index2-index1-1);
795 796
        const QString &note = s.mid(index3 + 1);
        const int lineNumber = s.mid(index2 + 1, index3 - index2 - 1).toInt();
hjk's avatar
hjk committed
797
        if (!filePath.isEmpty() && !findBookmark(filePath, lineNumber)) {
hjk's avatar
hjk committed
798 799
            Bookmark *b = new Bookmark(lineNumber, this);
            b->updateFileName(filePath);
800
            b->setNote(note);
con's avatar
con committed
801 802 803 804 805 806 807 808 809 810 811
            addBookmark(b, false);
        }
    } else {
        qDebug() << "BookmarkManager::addBookmark() Invalid bookmark string:" << s;
    }
}

/* Puts the bookmark in a string for storing it in the settings. */
QString BookmarkManager::bookmarkToString(const Bookmark *b)
{
    const QLatin1Char colon(':');
812 813
    // Using \t as delimiter because any another symbol can be a part of note.
    const QLatin1Char noteDelimiter('\t');
hjk's avatar
hjk committed
814
    return colon + b->fileName() +
815 816
            colon + QString::number(b->lineNumber()) +
            noteDelimiter + b->note();
con's avatar
con committed
817 818 819 820 821 822
}

/* Saves the bookmarks to the session settings. */
void BookmarkManager::saveBookmarks()
{
    QStringList list;
Vasiliy Sorokin's avatar
Vasiliy Sorokin committed
823
    foreach (const Bookmark *bookmark, m_bookmarksList)
hjk's avatar
hjk committed
824
        list << bookmarkToString(bookmark);
con's avatar
con committed
825

hjk's avatar
hjk committed
826
    SessionManager::setValue(QLatin1String("Bookmarks"), list);
con's avatar
con committed
827 828
}

hjk's avatar
hjk committed
829
void BookmarkManager::operateTooltip(QWidget *widget, const QPoint &pos, Bookmark *mark)
830 831 832 833
{
    if (!mark)
        return;

834
    if (mark->note().isEmpty())
hjk's avatar
hjk committed
835
        ToolTip::hide();
836
    else
837
        ToolTip::show(pos, TextContent(mark->note()), widget);
838 839
}

con's avatar
con committed
840 841 842
/* Loads the bookmarks from the session settings. */
void BookmarkManager::loadBookmarks()
{
843
    removeAllBookmarks();
hjk's avatar
hjk committed
844
    const QStringList &list = SessionManager::value(QLatin1String("Bookmarks")).toStringList();
con's avatar
con committed
845 846 847 848 849 850
    foreach (const QString &bookmarkString, list)
        addBookmark(bookmarkString);

    updateActionStatus();
}

hjk's avatar
hjk committed
851
void BookmarkManager::handleBookmarkTooltipRequest(IEditor *editor, const QPoint &pos, int line)
852
{
hjk's avatar
hjk committed
853 854
    Bookmark *mark = findBookmark(editor->document()->filePath(), line);
    operateTooltip(editor->widget(), pos, mark);
855 856
}

con's avatar
con committed
857 858 859 860 861
// BookmarkViewFactory

BookmarkViewFactory::BookmarkViewFactory(BookmarkManager *bm)
    : m_manager(bm)
{
862 863 864 865
    setDisplayName(BookmarkView::tr("Bookmarks"));
    setPriority(300);
    setId("Bookmarks");
    setActivationSequence(QKeySequence(Core::UseMacShortcuts ? tr("Alt+Meta+M") : tr("Alt+M")));
con's avatar
con committed
866 867
}

868
NavigationView BookmarkViewFactory::createWidget()
con's avatar
con committed
869
{
870
    return NavigationView(new BookmarkView(m_manager));
con's avatar
con committed
871
}
872 873 874

} // namespace Internal
} // namespace Bookmarks