treemodel.cpp 11.1 KB
Newer Older
hjk's avatar
hjk committed
1 2 3 4 5 6 7 8 9 10 11 12
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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.
hjk's avatar
hjk committed
15 16 17
**
** GNU Lesser General Public License Usage
** 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "treemodel.h"
#include "qtcassert.h"

/*!
    \class Utils::TreeModel

    \brief The TreeModel class is a convienience base class for models
    to use in a QTreeView.
*/

41 42 43 44 45 46 47 48 49 50 51 52 53
#if 0
#define CHECK_INDEX(index) \
    do { \
        if (index.isValid()) { \
            QTC_CHECK(index.model() == this); \
        } else { \
            QTC_CHECK(index.model() == 0); \
        } \
    } while (false)
#else
#define CHECK_INDEX(index)
#endif

hjk's avatar
hjk committed
54 55 56 57 58 59
namespace Utils {

//
// TreeItem
//
TreeItem::TreeItem()
60 61 62 63 64 65 66
    : m_parent(0), m_displays(0), m_lazy(false), m_populated(false),
      m_flags(Qt::ItemIsEnabled|Qt::ItemIsSelectable)
{
}

TreeItem::TreeItem(const QStringList &displays)
    : m_parent(0), m_displays(new QStringList(displays)), m_lazy(false), m_populated(false),
hjk's avatar
hjk committed
67 68 69 70 71 72 73
      m_flags(Qt::ItemIsEnabled|Qt::ItemIsSelectable)
{
}

TreeItem::~TreeItem()
{
    clear();
74
    delete m_displays;
hjk's avatar
hjk committed
75 76 77 78 79 80
}

TreeItem *TreeItem::child(int pos) const
{
    ensurePopulated();
    QTC_ASSERT(pos >= 0, return 0);
hjk's avatar
hjk committed
81
    return pos < m_children.size() ? m_children.at(pos) : 0;
hjk's avatar
hjk committed
82 83 84 85 86 87 88 89 90
}

bool TreeItem::isLazy() const
{
    return m_lazy;
}

int TreeItem::columnCount() const
{
91
    return m_displays ? m_displays->size() : 1;
hjk's avatar
hjk committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105
}

int TreeItem::rowCount() const
{
    ensurePopulated();
    return m_children.size();
}

void TreeItem::populate()
{
}

QVariant TreeItem::data(int column, int role) const
{
106 107
    if (role == Qt::DisplayRole && m_displays && column >= 0 && column < m_displays->size())
        return m_displays->at(column);
hjk's avatar
hjk committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
    return QVariant();
}

Qt::ItemFlags TreeItem::flags(int column) const
{
    Q_UNUSED(column);
    return m_flags;
}

void TreeItem::prependChild(TreeItem *item)
{
    QTC_CHECK(!item->parent());
    item->m_parent = this;
    m_children.prepend(item);
}

void TreeItem::appendChild(TreeItem *item)
{
    QTC_CHECK(!item->parent());
    item->m_parent = this;
    m_children.append(item);
}

131 132 133 134 135 136 137 138 139 140 141 142 143
TreeItem *TreeItem::lastChild() const
{
    return m_children.isEmpty() ? 0 : m_children.last();
}

int TreeItem::level() const
{
    int l = 0;
    for (TreeItem *item = this->parent(); item; item = item->parent())
        ++l;
    return l;
}

hjk's avatar
hjk committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
void TreeItem::setLazy(bool on)
{
    m_lazy = on;
}

void TreeItem::setFlags(Qt::ItemFlags flags)
{
    m_flags = flags;
}

void TreeItem::clear()
{
    while (m_children.size()) {
        TreeItem *item = m_children.takeLast();
        item->m_parent = 0;
        delete item;
    }
}

void TreeItem::ensurePopulated() const
{
    if (!m_populated) {
        if (isLazy())
            const_cast<TreeItem *>(this)->populate();
        m_populated = true;
    }
}

//
// TreeModel
//
TreeModel::TreeModel(QObject *parent)
    : QAbstractItemModel(parent), m_root(new TreeItem)
{
}

TreeModel::~TreeModel()
{
    delete m_root;
}

QModelIndex TreeModel::parent(const QModelIndex &idx) const
{
187
    CHECK_INDEX(idx);
hjk's avatar
hjk committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    if (!idx.isValid())
        return QModelIndex();

    const TreeItem *item = itemFromIndex(idx);
    const TreeItem *parent = item->parent();
    if (!parent || parent == m_root)
        return QModelIndex();

    const TreeItem *grandparent = parent->parent();
    if (!grandparent)
        return QModelIndex();

    for (int i = 0, n = grandparent->rowCount(); i < n; ++i)
        if (grandparent->child(i) == parent)
            return createIndex(i, 0, (void*) parent);

    return QModelIndex();
}

int TreeModel::rowCount(const QModelIndex &idx) const
{
209
    CHECK_INDEX(idx);
hjk's avatar
hjk committed
210 211 212 213 214 215 216 217 218
    if (!idx.isValid())
        return m_root->rowCount();
    if (idx.column() > 0)
        return 0;
    return itemFromIndex(idx)->rowCount();
}

int TreeModel::columnCount(const QModelIndex &idx) const
{
219
    CHECK_INDEX(idx);
hjk's avatar
hjk committed
220
    if (!idx.isValid())
hjk's avatar
hjk committed
221
        return m_root->columnCount();
hjk's avatar
hjk committed
222 223 224 225 226 227 228 229 230 231 232
    if (idx.column() > 0)
        return 0;
    return itemFromIndex(idx)->columnCount();
}

QVariant TreeModel::data(const QModelIndex &idx, int role) const
{
    TreeItem *item = itemFromIndex(idx);
    return item ? item->data(idx.column(), role) : QVariant();
}

hjk's avatar
hjk committed
233 234 235 236 237 238 239 240
QVariant TreeModel::headerData(int section, Qt::Orientation orientation,
                               int role) const
{
    if (orientation == Qt::Horizontal)
        return m_root->data(section, role);
    return QVariant();
}

hjk's avatar
hjk committed
241 242 243 244 245 246 247 248 249 250 251 252
Qt::ItemFlags TreeModel::flags(const QModelIndex &idx) const
{
    TreeItem *item = itemFromIndex(idx);
    return item ? item->flags(idx.column())
                : (Qt::ItemIsEnabled|Qt::ItemIsSelectable);
}

TreeItem *TreeModel::rootItem() const
{
    return m_root;
}

hjk's avatar
hjk committed
253 254 255 256 257 258
void TreeModel::setRootItem(TreeItem *item)
{
    delete m_root;
    m_root = item;
}

hjk's avatar
hjk committed
259 260
QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) const
{
261
    CHECK_INDEX(parent);
hjk's avatar
hjk committed
262 263 264 265 266 267 268 269 270 271 272 273
    if (!hasIndex(row, column, parent))
        return QModelIndex();

    const TreeItem *item = itemFromIndex(parent);
    QTC_ASSERT(item, return QModelIndex());
    if (row >= item->rowCount())
        return QModelIndex();
    return createIndex(row, column, (void*)(item->child(row)));
}

TreeItem *TreeModel::itemFromIndex(const QModelIndex &idx) const
{
274 275
    CHECK_INDEX(idx);
    return idx.isValid() ? static_cast<TreeItem*>(idx.internalPointer()) : m_root;
hjk's avatar
hjk committed
276 277 278 279 280
}

QModelIndex TreeModel::indexFromItem(const TreeItem *item) const
{
//    CHECK(checkItem(item));
hjk's avatar
hjk committed
281
    return item ? indexFromItemHelper(item, m_root, QModelIndex()) : QModelIndex();
hjk's avatar
hjk committed
282 283
}

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
void TreeModel::appendItem(TreeItem *parent, TreeItem *item)
{
    QTC_ASSERT(item, return);
    QTC_ASSERT(parent, return);

    QModelIndex idx = indexFromItem(parent);
    const int n = parent->rowCount();
    beginInsertRows(idx, n, n);
    parent->appendChild(item);
    endInsertRows();
}

void TreeModel::updateItem(TreeItem *item)
{
    QModelIndex idx = indexFromItem(item);
    dataChanged(idx.sibling(idx.row(), 0), idx.sibling(idx.row(), item->columnCount() - 1));
}

hjk's avatar
hjk committed
302 303 304 305 306 307 308 309 310 311 312 313
UntypedTreeLevelItems TreeModel::untypedLevelItems(int level, TreeItem *start) const
{
    if (start == 0)
        start = m_root;
    return UntypedTreeLevelItems(start, level);
}

UntypedTreeLevelItems TreeModel::untypedLevelItems(TreeItem *start) const
{
    return UntypedTreeLevelItems(start, 1);
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
void TreeModel::removeItem(TreeItem *item)
{
    QTC_ASSERT(item, return);
    TreeItem *parent = item->parent();
    QTC_ASSERT(parent, return);
    int pos = parent->m_children.indexOf(item);
    QTC_ASSERT(pos != -1, return);

    QModelIndex idx = indexFromItem(parent);
    beginRemoveRows(idx, pos, pos);
    item->m_parent = 0;
    parent->m_children.removeAt(pos);
    endRemoveRows();
}

329 330 331 332 333 334 335 336 337 338 339
void TreeModel::removeAllSubItems(TreeItem *item)
{
    QTC_ASSERT(item, return);
    if (item->rowCount() == 0)
        return;
    QModelIndex idx = indexFromItem(item);
    beginRemoveRows(idx, 0, item->rowCount() - 1);
    item->clear();
    endRemoveRows();
}

hjk's avatar
hjk committed
340 341 342
QModelIndex TreeModel::indexFromItemHelper(const TreeItem *needle,
    TreeItem *parentItem, const QModelIndex &parentIndex) const
{
343
    CHECK_INDEX(parentIndex);
hjk's avatar
hjk committed
344 345 346 347 348 349
    if (needle == parentItem)
        return parentIndex;
    for (int i = parentItem->rowCount(); --i >= 0; ) {
        TreeItem *childItem = parentItem->child(i);
        QModelIndex childIndex = index(i, 0, parentIndex);
        QModelIndex idx = indexFromItemHelper(needle, childItem, childIndex);
350
        CHECK_INDEX(idx);
hjk's avatar
hjk committed
351 352 353 354 355 356
        if (idx.isValid())
            return idx;
    }
    return QModelIndex();
}

hjk's avatar
hjk committed
357 358 359 360 361 362 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 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
//
// TreeLevelItems
//

UntypedTreeLevelItems::UntypedTreeLevelItems(TreeItem *item, int level)
    : m_item(item), m_level(level)
{}

UntypedTreeLevelItems::const_iterator::const_iterator(TreeItem *base, int level)
    : m_level(level)
{
    QTC_ASSERT(level > 0, return);
    if (base) {
        // "begin()"
        m_depth = 0;
        // Level x: The item m_item[x] is the m_pos[x]'th child of its
        // parent, out of m_size[x].
        m_pos[0] = 0;
        m_size[0] = 1;
        m_item[0] = base;
        goDown();
    } else {
        // "end()"
        m_depth = -1;
    }
}


// Result is either an item of the target level, or 'end'.
void UntypedTreeLevelItems::const_iterator::goDown()
{
    QTC_ASSERT(m_depth != -1, return);
    QTC_ASSERT(m_depth < m_level, return);
    do {
        TreeItem *curr = m_item[m_depth];
        int size = curr->rowCount();
        if (size == 0) {
            // This is a dead end not reaching to the desired level.
            goUpNextDown();
            return;
        }
        ++m_depth;
        m_size[m_depth] = size;
        m_pos[m_depth] = 0;
        m_item[m_depth] = curr->child(0);
    } while (m_depth < m_level);
    // Did not reach the required level? Set to end().
    if (m_depth != m_level)
        m_depth = -1;
}

void UntypedTreeLevelItems::const_iterator::goUpNextDown()
{
    // Go up until we can move sidewards.
    do {
        --m_depth;
        if (m_depth < 0)
            return; // Solid end.
    } while (++m_pos[m_depth] >= m_size[m_depth]);
    m_item[m_depth] = m_item[m_depth - 1]->child(m_pos[m_depth]);
    goDown();
}

bool UntypedTreeLevelItems::const_iterator::operator==(UntypedTreeLevelItems::const_iterator other) const
{
    if (m_depth != other.m_depth)
        return false;
    for (int i = 0; i <= m_depth; ++i)
        if (m_item[i] != other.m_item[i])
            return false;
    return true;
}

void UntypedTreeLevelItems::const_iterator::operator++()
{
    QTC_ASSERT(m_depth == m_level, return);

    int pos = ++m_pos[m_depth];
    if (pos < m_size[m_depth])
        m_item[m_depth] = m_item[m_depth - 1]->child(pos);
    else
        goUpNextDown();
}

UntypedTreeLevelItems::const_iterator UntypedTreeLevelItems::begin() const
{
    return const_iterator(m_item, m_level);
}

UntypedTreeLevelItems::const_iterator UntypedTreeLevelItems::end() const
{
    return const_iterator(0, m_level);
}

hjk's avatar
hjk committed
451
} // namespace Utils