bookmarkmanager.cpp 26.3 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 13 14
** 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
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** 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
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

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

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

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

48 49 50
#include <QDebug>
#include <QDir>
#include <QFileInfo>
hjk's avatar
hjk committed
51

52 53 54 55
#include <QAction>
#include <QContextMenuEvent>
#include <QMenu>
#include <QPainter>
56
#include <QInputDialog>
con's avatar
con committed
57 58 59 60

Q_DECLARE_METATYPE(Bookmarks::Internal::Bookmark*)

using namespace ProjectExplorer;
61
using namespace TextEditor;
62
using namespace Core;
hjk's avatar
hjk committed
63
using namespace Utils;
con's avatar
con committed
64

65 66 67
namespace Bookmarks {
namespace Internal {

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

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;
}

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

hjk's avatar
hjk committed
90 91
    QPixmap pixmap(width+1, height);
    pixmap.fill(c);
con's avatar
con committed
92

hjk's avatar
hjk committed
93
    QPainter painter(&pixmap);
con's avatar
con committed
94 95 96 97 98 99 100 101 102
    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
103
    painter.setBrush(lg);
con's avatar
con committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    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);
119
    static int lwidth = fm.width(QLatin1String("8888")) + 18;
con's avatar
con committed
120 121 122 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

    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
150
    QString topLeft = index.data(BookmarkManager::Filename).toString();
con's avatar
con committed
151 152 153
    painter->drawText(6, 2 + opt.rect.top() + fm.ascent(), topLeft);

    QString topRight = index.data(BookmarkManager::LineNumber).toString();
Tobias Hunger's avatar
Tobias Hunger committed
154
    // Check whether we need to be fancy and paint some background
con's avatar
con committed
155 156 157
    int fwidth = fm.width(topLeft);
    if (fwidth + lwidth > opt.rect.width()) {
        int left = opt.rect.right() - lwidth;
hjk's avatar
hjk committed
158
        painter->drawPixmap(left, opt.rect.top(), selected ? m_selectedPixmap : m_normalPixmap);
con's avatar
con committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    }
    // 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
180
//            if (idx == -1) {
con's avatar
con committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
//                // 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
197 198 199
    QString lineText = index.data(BookmarkManager::Note).toString().trimmed();
    if (lineText.isEmpty())
        lineText = index.data(BookmarkManager::LineText).toString().trimmed();
200

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

    // 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
209 210 211
BookmarkView::BookmarkView(BookmarkManager *manager)  :
    m_bookmarkContext(new Core::IContext(this)),
    m_manager(manager)
con's avatar
con committed
212 213 214
{
    setWindowTitle(tr("Bookmarks"));

hjk's avatar
hjk committed
215 216
    m_bookmarkContext->setWidget(this);
    m_bookmarkContext->setContext(Core::Context(Constants::BOOKMARKS_CONTEXT));
con's avatar
con committed
217

hjk's avatar
hjk committed
218
    ICore::addContextObject(m_bookmarkContext);
con's avatar
con committed
219

hjk's avatar
hjk committed
220 221
    Utils::ListView::setModel(manager);

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

    connect(this, SIGNAL(clicked(QModelIndex)),
            this, SLOT(gotoBookmark(QModelIndex)));
    connect(this, SIGNAL(activated(QModelIndex)),
            this, SLOT(gotoBookmark(QModelIndex)));
con's avatar
con committed
234 235 236 237
}

BookmarkView::~BookmarkView()
{
hjk's avatar
hjk committed
238
    ICore::removeContextObject(m_bookmarkContext);
con's avatar
con committed
239 240 241 242 243
}

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

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

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

263 264 265 266
    connect(moveUp, SIGNAL(triggered()),
            m_manager, SLOT(moveUp()));
    connect(moveDown, SIGNAL(triggered()),
            m_manager, SLOT(moveDown()));
con's avatar
con committed
267 268 269 270
    connect(remove, SIGNAL(triggered()),
            this, SLOT(removeFromContextMenu()));
    connect(removeAll, SIGNAL(triggered()),
            this, SLOT(removeAll()));
271 272
    connect(editNote, SIGNAL(triggered()),
            m_manager, SLOT(editNote()));
con's avatar
con committed
273 274 275 276 277 278 279 280 281 282 283

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

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

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

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

con's avatar
con committed
298 299
void BookmarkView::removeAll()
{
300 301 302 303 304 305
    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;
306 307

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

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

////
// BookmarkManager
////

325 326 327
BookmarkManager::BookmarkManager() :
    m_bookmarkIcon(QLatin1String(":/bookmarks/images/bookmark.png")),
    m_selectionModel(new QItemSelectionModel(this, this))
con's avatar
con committed
328
{
329
    connect(Core::ICore::instance(), SIGNAL(contextChanged(QList<Core::IContext*>,Core::Context)),
con's avatar
con committed
330 331
            this, SLOT(updateActionStatus()));

hjk's avatar
hjk committed
332
    connect(SessionManager::instance(), SIGNAL(sessionLoaded(QString)),
con's avatar
con committed
333 334 335 336 337 338 339 340 341 342 343
            this, SLOT(loadBookmarks()));

    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
344
        qDeleteAll(*bookmarks);
con's avatar
con committed
345 346 347 348 349 350 351 352 353
        delete bookmarks;
    }
}

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

354 355 356 357 358 359
bool BookmarkManager::hasBookmarkInPosition(const QString &fileName, int lineNumber)
{
    QFileInfo fi(fileName);
    return findBookmark(fi.path(), fi.fileName(), lineNumber);
}

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

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();

    if (role == BookmarkManager::Filename)
        return m_bookmarksList.at(index.row())->fileName();
hjk's avatar
hjk committed
395
    if (role == BookmarkManager::LineNumber)
con's avatar
con committed
396
        return m_bookmarksList.at(index.row())->lineNumber();
hjk's avatar
hjk committed
397
    if (role == BookmarkManager::Directory)
con's avatar
con committed
398
        return m_bookmarksList.at(index.row())->path();
hjk's avatar
hjk committed
399
    if (role == BookmarkManager::LineText)
con's avatar
con committed
400
        return m_bookmarksList.at(index.row())->lineText();
hjk's avatar
hjk committed
401
    if (role == BookmarkManager::Note)
402
        return m_bookmarksList.at(index.row())->note();
hjk's avatar
hjk committed
403
    if (role == Qt::ToolTipRole)
404
        return QDir::toNativeSeparators(m_bookmarksList.at(index.row())->filePath());
con's avatar
con committed
405 406 407 408 409 410

    return QVariant();
}

void BookmarkManager::toggleBookmark()
{
411
    ITextEditor *editor = ITextEditor::currentTextEditor();
con's avatar
con committed
412 413 414
    if (!editor)
        return;

415
    toggleBookmark(editor->document()->filePath(), editor->currentLine());
hjk's avatar
hjk committed
416 417 418 419 420 421
}

void BookmarkManager::toggleBookmark(const QString &fileName, int lineNumber)
{
    const QFileInfo fi(fileName);
    const int editorLine = lineNumber;
con's avatar
con committed
422 423

    // Remove any existing bookmark on this line
hjk's avatar
hjk committed
424
    if (Bookmark *mark = findBookmark(fi.path(), fi.fileName(), lineNumber)) {
con's avatar
con committed
425 426 427 428 429 430 431
        // 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
    Bookmark *bookmark = new Bookmark(fi.filePath(), editorLine, this);
432
    bookmark->init();
con's avatar
con committed
433 434 435 436 437
    addBookmark(bookmark);
}

void BookmarkManager::updateBookmark(Bookmark *bookmark)
{
438 439 440 441
    const int idx = m_bookmarksList.indexOf(bookmark);
    if (idx == -1)
        return;

con's avatar
con committed
442 443 444 445
    emit dataChanged(index(idx, 0, QModelIndex()), index(idx, 2, QModelIndex()));
    saveBookmarks();
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
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
469 470
void BookmarkManager::removeBookmark(Bookmark *bookmark)
{
471 472 473
    int idx = m_bookmarksList.indexOf(bookmark);
    beginRemoveRows(QModelIndex(), idx, idx);

con's avatar
con committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    const QFileInfo fi(bookmark->filePath() );
    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;
    }

491

con's avatar
con committed
492 493 494 495 496 497 498 499 500 501
    m_bookmarksList.removeAt(idx);
    endRemoveRows();

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

    updateActionStatus();
    saveBookmarks();
}

hjk's avatar
hjk committed
502
Bookmark *BookmarkManager::bookmarkForIndex(const QModelIndex &index) const
con's avatar
con committed
503 504 505 506 507 508
{
    if (!index.isValid() || index.row() >= m_bookmarksList.size())
        return 0;
    return m_bookmarksList.at(index.row());
}

hjk's avatar
hjk committed
509
bool BookmarkManager::gotoBookmark(Bookmark *bookmark)
con's avatar
con committed
510
{
hjk's avatar
hjk committed
511 512
    if (IEditor *editor = EditorManager::openEditorAt(bookmark->filePath(), bookmark->lineNumber()))
        return editor->currentLine() == bookmark->lineNumber();
513
    return false;
con's avatar
con committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527
}

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

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

void BookmarkManager::documentPrevNext(bool next)
{
528
    ITextEditor *editor = ITextEditor::currentTextEditor();
con's avatar
con committed
529
    int editorLine = editor->currentLine();
530
    QFileInfo fi(editor->document()->filePath());
con's avatar
con committed
531 532 533 534 535 536 537
    if (!m_bookmarksMap.contains(fi.path()))
        return;

    int firstLine = -1;
    int lastLine = -1;
    int prevLine = -1;
    int nextLine = -1;
hjk's avatar
hjk committed
538
    const QList<Bookmark *> marks = m_bookmarksMap.value(fi.path())->values(fi.fileName());
con's avatar
con committed
539 540 541 542 543 544 545 546 547 548 549 550 551
    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;
    }

552
    EditorManager::addCurrentPositionToNavigationHistory();
con's avatar
con committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
    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;
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
    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
587 588 589 590 591 592 593
}

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

con's avatar
con committed
595
    int row = current.row();
596 597 598 599 600 601 602 603 604 605 606 607 608 609
    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
610 611 612 613 614 615 616
}

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

617
    ITextEditor *editor = ITextEditor::currentTextEditor();
con's avatar
con committed
618 619 620
    if (!editor)
        return HasBookMarks;

621
    const QFileInfo fi(editor->document()->filePath());
con's avatar
con committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

    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
653 654

    saveBookmarks();
con's avatar
con committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
}

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
674 675

    saveBookmarks();
con's avatar
con committed
676 677
}

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
void BookmarkManager::editNote(const QString &fileName, int lineNumber)
{
    QFileInfo fi(fileName);
    Bookmark *b = findBookmark(fi.path(), fi.fileName(), lineNumber);
    QModelIndex current = selectionModel()->currentIndex();
    selectionModel()->setCurrentIndex(current.sibling(m_bookmarksList.indexOf(b), 0),
                                      QItemSelectionModel::Select | QItemSelectionModel::Clear);

    editNote();
}

void BookmarkManager::editNote()
{
    QModelIndex current = selectionModel()->currentIndex();
    Bookmark *b = m_bookmarksList.at(current.row());

    bool inputOk = false;
695
    QString noteText = QInputDialog::getText(0, tr("Edit Note"),
696 697 698
                                             tr("Note text:"), QLineEdit::Normal,
                                             b->note(), &inputOk);
    if (inputOk) {
Orgad Shaneh's avatar
Orgad Shaneh committed
699
        b->updateNote(noteText.replace(QLatin1Char('\t'), QLatin1Char(' ')));
700
        emit dataChanged(current, current);
Vasiliy Sorokin's avatar
Vasiliy Sorokin committed
701
        saveBookmarks();
702 703 704
    }
}

con's avatar
con committed
705
/* Returns the bookmark at the given file and line number, or 0 if no such bookmark exists. */
hjk's avatar
hjk committed
706
Bookmark *BookmarkManager::findBookmark(const QString &path, const QString &fileName, int lineNumber)
con's avatar
con committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
{
    if (m_bookmarksMap.contains(path)) {
        foreach (Bookmark *bookmark, m_bookmarksMap.value(path)->values(fileName)) {
            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());
    const QFileInfo fi(bookmark->filePath());
    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)
{
744
    // index3 is a frontier beetween note text and other bookmarks data
745
    int index3 = s.lastIndexOf(QLatin1Char('\t'));
746 747
    if (index3 < 0)
        index3 = s.size();
748 749
    int index2 = s.lastIndexOf(QLatin1Char(':'), index3 - 1);
    int index1 = s.indexOf(QLatin1Char(':'));
750 751

    if (index3 != -1 || index2 != -1 || index1 != -1) {
con's avatar
con committed
752
        const QString &filePath = s.mid(index1+1, index2-index1-1);
753 754
        const QString &note = s.mid(index3 + 1);
        const int lineNumber = s.mid(index2 + 1, index3 - index2 - 1).toInt();
con's avatar
con committed
755 756 757 758
        const QFileInfo fi(filePath);

        if (!filePath.isEmpty() && !findBookmark(fi.path(), fi.fileName(), lineNumber)) {
            Bookmark *b = new Bookmark(filePath, lineNumber, this);
759
            b->setNote(note);
760
            b->init();
con's avatar
con committed
761 762 763 764 765 766 767 768 769 770 771
            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(':');
772 773
    // Using \t as delimiter because any another symbol can be a part of note.
    const QLatin1Char noteDelimiter('\t');
con's avatar
con committed
774
    // Empty string was the name of the bookmark, which now is always ""
775 776 777
    return QLatin1String("") + colon + b->filePath() +
            colon + QString::number(b->lineNumber()) +
            noteDelimiter + b->note();
con's avatar
con committed
778 779 780 781 782 783
}

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

hjk's avatar
hjk committed
787
    SessionManager::setValue(QLatin1String("Bookmarks"), list);
con's avatar
con committed
788 789
}

hjk's avatar
hjk committed
790
void BookmarkManager::operateTooltip(ITextEditor *textEditor, const QPoint &pos, Bookmark *mark)
791 792 793 794
{
    if (!mark)
        return;

795
    if (mark->note().isEmpty())
hjk's avatar
hjk committed
796
        ToolTip::hide();
797
    else
hjk's avatar
hjk committed
798
        ToolTip::show(pos, TextContent(mark->note()), textEditor->widget());
799 800
}

con's avatar
con committed
801 802 803
/* Loads the bookmarks from the session settings. */
void BookmarkManager::loadBookmarks()
{
804
    removeAllBookmarks();
hjk's avatar
hjk committed
805
    const QStringList &list = SessionManager::value(QLatin1String("Bookmarks")).toStringList();
con's avatar
con committed
806 807 808 809 810 811
    foreach (const QString &bookmarkString, list)
        addBookmark(bookmarkString);

    updateActionStatus();
}

hjk's avatar
hjk committed
812
void BookmarkManager::handleBookmarkRequest(ITextEditor *textEditor,
813
                                            int line,
hjk's avatar
hjk committed
814
                                            ITextEditor::MarkRequestKind kind)
815
{
hjk's avatar
hjk committed
816
    if (kind == ITextEditor::BookmarkRequest && textEditor->document())
817
        toggleBookmark(textEditor->document()->filePath(), line);
818 819
}

hjk's avatar
hjk committed
820
void BookmarkManager::handleBookmarkTooltipRequest(ITextEditor *textEditor, const QPoint &pos,
821 822 823
                                            int line)
{
    if (textEditor->document()) {
824
        const QFileInfo fi(textEditor->document()->filePath());
825 826 827 828 829
        Bookmark *mark = findBookmark(fi.path(), fi.fileName(), line);
        operateTooltip(textEditor, pos, mark);
    }
}

con's avatar
con committed
830 831 832 833 834 835 836
// BookmarkViewFactory

BookmarkViewFactory::BookmarkViewFactory(BookmarkManager *bm)
    : m_manager(bm)
{
}

837
QString BookmarkViewFactory::displayName() const
con's avatar
con committed
838
{
839
    return BookmarkView::tr("Bookmarks");
con's avatar
con committed
840 841
}

842 843 844 845 846
int BookmarkViewFactory::priority() const
{
    return 300;
}

847
Id BookmarkViewFactory::id() const
848
{
849
    return "Bookmarks";
850 851 852
}

QKeySequence BookmarkViewFactory::activationSequence() const
con's avatar
con committed
853
{
854
    return QKeySequence(Core::UseMacShortcuts ? tr("Alt+Meta+M") : tr("Alt+M"));
con's avatar
con committed
855 856 857 858
}

Core::NavigationView BookmarkViewFactory::createWidget()
{
hjk's avatar
hjk committed
859
    BookmarkView *bookmarkView = new BookmarkView(m_manager);
con's avatar
con committed
860 861 862 863
    Core::NavigationView view;
    view.widget = bookmarkView;
    return view;
}
864 865 866

} // namespace Internal
} // namespace Bookmarks