1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 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 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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 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 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
|
/*
SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "tocmodel.h"
#include <QApplication>
#include <QList>
#include <QTreeView>
#include <qdom.h>
#include <QFont>
#include "core/document.h"
#include "core/page.h"
Q_DECLARE_METATYPE(QModelIndex)
struct TOCItem {
TOCItem();
TOCItem(TOCItem *parent, const QDomElement &e);
~TOCItem();
TOCItem(const TOCItem &) = delete;
TOCItem &operator=(const TOCItem &) = delete;
QString text;
Okular::DocumentViewport viewport;
QString extFileName;
QString url;
bool highlight : 1;
TOCItem *parent;
QList<TOCItem *> children;
TOCModelPrivate *model;
};
class TOCModelPrivate
{
public:
explicit TOCModelPrivate(TOCModel *qq);
~TOCModelPrivate();
void addChildren(const QDomNode &parentNode, TOCItem *parentItem);
QModelIndex indexForItem(TOCItem *item) const;
void findViewport(const Okular::DocumentViewport &viewport, TOCItem *item, QList<TOCItem *> &list) const;
TOCModel *q;
TOCItem *root;
bool dirty : 1;
Okular::Document *document;
QList<TOCItem *> itemsToOpen;
QList<TOCItem *> currentPage;
TOCModel *m_oldModel;
QList<QModelIndex> m_oldTocExpandedIndexes;
Q_DISABLE_COPY(TOCModelPrivate)
};
TOCItem::TOCItem()
: highlight(false)
, parent(nullptr)
, model(nullptr)
{
}
TOCItem::TOCItem(TOCItem *_parent, const QDomElement &e)
: highlight(false)
, parent(_parent)
{
parent->children.append(this);
model = parent->model;
text = e.tagName();
// viewport loading
if (e.hasAttribute(QStringLiteral("Viewport"))) {
// if the node has a viewport, set it
viewport = Okular::DocumentViewport(e.attribute(QStringLiteral("Viewport")));
} else if (e.hasAttribute(QStringLiteral("ViewportName"))) {
// if the node references a viewport, get the reference and set it
const QString &page = e.attribute(QStringLiteral("ViewportName"));
QString viewport_string = model->document->metaData(QStringLiteral("NamedViewport"), page).toString();
if (!viewport_string.isEmpty()) {
viewport = Okular::DocumentViewport(viewport_string);
}
}
extFileName = e.attribute(QStringLiteral("ExternalFileName"));
url = e.attribute(QStringLiteral("URL"));
}
TOCItem::~TOCItem()
{
qDeleteAll(children);
}
TOCModelPrivate::TOCModelPrivate(TOCModel *qq)
: q(qq)
, root(new TOCItem)
, dirty(false)
, document(nullptr)
, m_oldModel(nullptr)
{
root->model = this;
}
TOCModelPrivate::~TOCModelPrivate()
{
delete root;
delete m_oldModel;
}
void TOCModelPrivate::addChildren(const QDomNode &parentNode, TOCItem *parentItem)
{
TOCItem *currentItem = nullptr;
QDomNode n = parentNode.firstChild();
while (!n.isNull()) {
// convert the node to an element (sure it is)
QDomElement e = n.toElement();
// insert the entry as top level (listview parented) or 2nd+ level
currentItem = new TOCItem(parentItem, e);
// descend recursively and advance to the next node
if (e.hasChildNodes()) {
addChildren(n, currentItem);
}
// open/keep close the item
bool isOpen = false;
if (e.hasAttribute(QStringLiteral("Open"))) {
isOpen = QVariant(e.attribute(QStringLiteral("Open"))).toBool();
}
if (isOpen) {
itemsToOpen.append(currentItem);
}
n = n.nextSibling();
Q_EMIT q->countChanged();
}
}
QModelIndex TOCModelPrivate::indexForItem(TOCItem *item) const
{
if (item->parent) {
int id = item->parent->children.indexOf(item);
if (id >= 0 && id < item->parent->children.count()) {
return q->createIndex(id, 0, item);
}
}
return QModelIndex();
}
void TOCModelPrivate::findViewport(const Okular::DocumentViewport &viewport, TOCItem *item, QList<TOCItem *> &list) const
{
TOCItem *todo = item;
while (todo) {
const TOCItem *current = todo;
todo = nullptr;
TOCItem *pos = nullptr;
for (TOCItem *child : current->children) {
if (child->viewport.isValid()) {
if (child->viewport.pageNumber <= viewport.pageNumber) {
pos = child;
if (child->viewport.pageNumber == viewport.pageNumber) {
break;
}
} else {
break;
}
}
}
if (pos) {
list.append(pos);
todo = pos;
}
}
}
TOCModel::TOCModel(Okular::Document *document, QObject *parent)
: QAbstractItemModel(parent)
, d(new TOCModelPrivate(this))
{
d->document = document;
qRegisterMetaType<QModelIndex>();
}
TOCModel::~TOCModel()
{
delete d;
}
QHash<int, QByteArray> TOCModel::roleNames() const
{
QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
roles[PageRole] = "page";
roles[PageLabelRole] = "pageLabel";
roles[HighlightRole] = "highlight";
roles[HighlightedParentRole] = "highlightedParent";
return roles;
}
int TOCModel::columnCount(const QModelIndex &parent) const
{
Q_UNUSED(parent)
return 1;
}
QVariant TOCModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid()) {
return QVariant();
}
TOCItem *item = static_cast<TOCItem *>(index.internalPointer());
switch (role) {
case Qt::DisplayRole:
case Qt::ToolTipRole:
return item->text;
break;
case Qt::FontRole:
if (item->highlight) {
QFont font;
font.setBold(true);
const TOCItem *lastHighlighted = d->currentPage.last();
// in the mobile version our parent is not a QTreeView; embolden the last highlighted item
// TODO misusing parent() here, fix
QTreeView *view = dynamic_cast<QTreeView *>(QObject::parent());
if (!view) {
if (item == lastHighlighted) {
return font;
}
return QVariant();
}
if (view->isExpanded(index)) {
// if this is the last highlighted node, its child is on a page below, thus it gets emboldened
if (item == lastHighlighted) {
return font;
}
} else {
return font;
}
}
break;
case HighlightRole:
return item->highlight;
case PageRole:
if (item->viewport.isValid()) {
return item->viewport.pageNumber + 1;
}
break;
case PageLabelRole:
if (item->viewport.isValid() && item->viewport.pageNumber < int(d->document->pages())) {
return d->document->page(item->viewport.pageNumber)->label();
}
break;
}
return QVariant();
}
bool TOCModel::hasChildren(const QModelIndex &parent) const
{
if (!parent.isValid()) {
return true;
}
TOCItem *item = static_cast<TOCItem *>(parent.internalPointer());
return !item->children.isEmpty();
}
QVariant TOCModel::headerData(int section, Qt::Orientation orientation, int role) const
{
if (orientation != Qt::Horizontal) {
return QVariant();
}
if (section == 0 && role == Qt::DisplayRole) {
return QStringLiteral("Topics");
}
return QVariant();
}
QModelIndex TOCModel::index(int row, int column, const QModelIndex &parent) const
{
if (row < 0 || column != 0) {
return QModelIndex();
}
TOCItem *item = parent.isValid() ? static_cast<TOCItem *>(parent.internalPointer()) : d->root;
if (row < item->children.count()) {
return createIndex(row, column, item->children.at(row));
}
return QModelIndex();
}
QModelIndex TOCModel::parent(const QModelIndex &index) const
{
if (!index.isValid()) {
return QModelIndex();
}
TOCItem *item = static_cast<TOCItem *>(index.internalPointer());
return d->indexForItem(item->parent);
}
int TOCModel::rowCount(const QModelIndex &parent) const
{
TOCItem *item = parent.isValid() ? static_cast<TOCItem *>(parent.internalPointer()) : d->root;
return item->children.count();
}
static QModelIndex indexForIndex(const QModelIndex &oldModelIndex, QAbstractItemModel *newModel)
{
QModelIndex newModelIndex;
if (oldModelIndex.parent().isValid()) {
newModelIndex = newModel->index(oldModelIndex.row(), oldModelIndex.column(), indexForIndex(oldModelIndex.parent(), newModel));
} else {
newModelIndex = newModel->index(oldModelIndex.row(), oldModelIndex.column());
}
return newModelIndex;
}
void TOCModel::fill(const Okular::DocumentSynopsis *toc)
{
if (!toc) {
return;
}
clear();
Q_EMIT layoutAboutToBeChanged();
d->addChildren(*toc, d->root);
d->dirty = true;
Q_EMIT layoutChanged();
if (equals(d->m_oldModel)) {
for (const QModelIndex &oldIndex : std::as_const(d->m_oldTocExpandedIndexes)) {
const QModelIndex idx = indexForIndex(oldIndex, this);
if (!idx.isValid()) {
continue;
}
// TODO misusing parent() here, fix
QMetaObject::invokeMethod(QObject::parent(), "expand", Qt::QueuedConnection, Q_ARG(QModelIndex, idx));
}
} else {
for (TOCItem *item : std::as_const(d->itemsToOpen)) {
const QModelIndex idx = d->indexForItem(item);
if (!idx.isValid()) {
continue;
}
// TODO misusing parent() here, fix
QMetaObject::invokeMethod(QObject::parent(), "expand", Qt::QueuedConnection, Q_ARG(QModelIndex, idx));
}
}
d->itemsToOpen.clear();
delete d->m_oldModel;
d->m_oldModel = nullptr;
d->m_oldTocExpandedIndexes.clear();
}
void TOCModel::clear()
{
if (!d->dirty) {
return;
}
beginResetModel();
qDeleteAll(d->root->children);
d->root->children.clear();
d->currentPage.clear();
endResetModel();
d->dirty = false;
}
void TOCModel::setCurrentViewport(const Okular::DocumentViewport &viewport)
{
for (TOCItem *item : std::as_const(d->currentPage)) {
QModelIndex idx = d->indexForItem(item);
if (!idx.isValid()) {
continue;
}
item->highlight = false;
Q_EMIT dataChanged(idx, idx);
}
d->currentPage.clear();
QList<TOCItem *> newCurrentPage;
d->findViewport(viewport, d->root, newCurrentPage);
d->currentPage = newCurrentPage;
for (TOCItem *item : std::as_const(d->currentPage)) {
QModelIndex idx = d->indexForItem(item);
if (!idx.isValid()) {
continue;
}
item->highlight = true;
Q_EMIT dataChanged(idx, idx);
}
}
bool TOCModel::isEmpty() const
{
return d->root->children.isEmpty();
}
bool TOCModel::equals(const TOCModel *model) const
{
if (model) {
return checkequality(model);
} else {
return false;
}
}
void TOCModel::setOldModelData(TOCModel *model, const QList<QModelIndex> &list)
{
delete d->m_oldModel;
d->m_oldModel = model;
d->m_oldTocExpandedIndexes = list;
}
bool TOCModel::hasOldModelData() const
{
return (d->m_oldModel != nullptr);
}
TOCModel *TOCModel::clearOldModelData() const
{
TOCModel *oldModel = d->m_oldModel;
d->m_oldModel = nullptr;
d->m_oldTocExpandedIndexes.clear();
return oldModel;
}
QString TOCModel::externalFileNameForIndex(const QModelIndex &index) const
{
if (!index.isValid()) {
return QString();
}
const TOCItem *item = static_cast<TOCItem *>(index.internalPointer());
return item->extFileName;
}
Okular::DocumentViewport TOCModel::viewportForIndex(const QModelIndex &index) const
{
if (!index.isValid()) {
return Okular::DocumentViewport();
}
const TOCItem *item = static_cast<TOCItem *>(index.internalPointer());
return item->viewport;
}
QString TOCModel::urlForIndex(const QModelIndex &index) const
{
if (!index.isValid()) {
return QString();
}
const TOCItem *item = static_cast<TOCItem *>(index.internalPointer());
return item->url;
}
bool TOCModel::checkequality(const TOCModel *model, const QModelIndex &parentA, const QModelIndex &parentB) const
{
if (rowCount(parentA) != model->rowCount(parentB)) {
return false;
}
for (int i = 0; i < rowCount(parentA); i++) {
QModelIndex indxA = index(i, 0, parentA);
QModelIndex indxB = model->index(i, 0, parentB);
if (indxA.data() != indxB.data()) {
return false;
}
if (hasChildren(indxA) != model->hasChildren(indxB)) {
return false;
}
if (!checkequality(model, indxA, indxB)) {
return false;
}
}
return true;
}
#include "moc_tocmodel.cpp"
|