#include <QMimeData>
#include <QTimer>
-#define KFILEITEMMODEL_DEBUG
+// #define KFILEITEMMODEL_DEBUG
KFileItemModel::KFileItemModel(KDirLister* dirLister, QObject* parent) :
KItemModelBase("name", parent),
m_caseSensitivity(Qt::CaseInsensitive),
m_itemData(),
m_items(),
- m_nameFilter(),
+ m_filter(),
m_filteredItems(),
m_requestRole(),
m_minimumUpdateIntervalTimer(0),
m_pendingItemsToInsert(),
m_pendingEmitLoadingCompleted(false),
m_groups(),
- m_rootExpansionLevel(-1),
+ m_rootExpansionLevel(UninitializedRootExpansionLevel),
m_expandedUrls(),
m_urlsToExpand()
{
m_roles = roles;
if (count() > 0) {
- const bool supportedExpanding = m_requestRole[IsExpandedRole] && m_requestRole[ExpansionLevelRole];
- const bool willSupportExpanding = roles.contains("isExpanded") && roles.contains("expansionLevel");
+ const bool supportedExpanding = m_requestRole[ExpansionLevelRole];
+ const bool willSupportExpanding = roles.contains("expansionLevel");
if (supportedExpanding && !willSupportExpanding) {
// No expanding is supported anymore. Take care to delete all items that have an expansion level
// that is not 0 (and hence are part of an expanded item).
bool KFileItemModel::setExpanded(int index, bool expanded)
{
- if (isExpanded(index) == expanded || index < 0 || index >= count()) {
+ if (!isExpandable(index) || isExpanded(index) == expanded) {
return false;
}
bool KFileItemModel::isExpandable(int index) const
{
if (index >= 0 && index < count()) {
- return m_itemData.at(index)->item.isDir();
+ return m_itemData.at(index)->values.value("isExpandable").toBool();
}
return false;
}
void KFileItemModel::setExpanded(const QSet<KUrl>& urls)
{
-
const KDirLister* dirLister = m_dirLister.data();
if (!dirLister) {
return;
void KFileItemModel::setNameFilter(const QString& nameFilter)
{
- if (m_nameFilter != nameFilter) {
+ if (m_filter.pattern() != nameFilter) {
dispatchPendingItemsToInsert();
- m_nameFilter = nameFilter;
+ m_filter.setPattern(nameFilter);
// Check which shown items from m_itemData must get
// hidden and hence moved to m_filteredItems.
KFileItemList newFilteredItems;
foreach (ItemData* itemData, m_itemData) {
- if (!matchesNameFilter(itemData->item)) {
- newFilteredItems.append(itemData->item);
- m_filteredItems.insert(itemData->item);
+ if (!m_filter.matches(itemData->item)) {
+ // Only filter non-expanded items as child items may never
+ // exist without a parent item
+ if (!itemData->values.value("isExpanded").toBool()) {
+ newFilteredItems.append(itemData->item);
+ m_filteredItems.insert(itemData->item);
+ }
}
}
QMutableSetIterator<KFileItem> it(m_filteredItems);
while (it.hasNext()) {
const KFileItem item = it.next();
- if (matchesNameFilter(item)) {
+ if (m_filter.matches(item)) {
newVisibleItems.append(item);
m_filteredItems.remove(item);
}
QString KFileItemModel::nameFilter() const
{
- return m_nameFilter;
+ return m_filter.pattern();
}
void KFileItemModel::onGroupedSortingChanged(bool current)
void KFileItemModel::slotNewItems(const KFileItemList& items)
{
+ Q_ASSERT(!items.isEmpty());
+
if (m_requestRole[ExpansionLevelRole] && m_rootExpansionLevel >= 0) {
- // If the expanding of items is enabled in the model, it might be
- // possible that the call dirLister->openUrl(url, KDirLister::Keep) in
- // KFileItemModel::setExpanded() results in emitting of the same items
- // twice due to the Keep-parameter. This case happens if an item gets
- // expanded, collapsed and expanded again before the items could be loaded
- // for the first expansion.
- foreach (const KFileItem& item, items) {
- const int index = m_items.value(item.url(), -1);
- if (index >= 0) {
- // The items are already part of the model.
- return;
- }
+ // To be able to compare whether the new items may be inserted as children
+ // of a parent item the pending items must be added to the model first.
+ dispatchPendingItemsToInsert();
+
+ KFileItem item = items.first();
+
+ // If the expanding of items is enabled, the call
+ // dirLister->openUrl(url, KDirLister::Keep) in KFileItemModel::setExpanded()
+ // might result in emitting the same items twice due to the Keep-parameter.
+ // This case happens if an item gets expanded, collapsed and expanded again
+ // before the items could be loaded for the first expansion.
+ const int index = m_items.value(item.url(), -1);
+ if (index >= 0) {
+ // The items are already part of the model.
+ return;
+ }
+
+ // KDirLister keeps the children of items that got expanded once even if
+ // they got collapsed again with KFileItemModel::setExpanded(false). So it must be
+ // checked whether the parent for new items is still expanded.
+ KUrl parentUrl = item.url().upUrl();
+ parentUrl.adjustPath(KUrl::RemoveTrailingSlash);
+ const int parentIndex = m_items.value(parentUrl, -1);
+ if (parentIndex >= 0 && !m_itemData[parentIndex]->values.value("isExpanded").toBool()) {
+ // The parent is not expanded.
+ return;
}
}
- if (m_nameFilter.isEmpty()) {
+ if (m_filter.pattern().isEmpty()) {
m_pendingItemsToInsert.append(items);
} else {
// The name-filter is active. Hide filtered items
// the filtered items in m_filteredItems.
KFileItemList filteredItems;
foreach (const KFileItem& item, items) {
- if (matchesNameFilter(item)) {
+ if (m_filter.matches(item)) {
filteredItems.append(item);
} else {
m_filteredItems.insert(item);
{
dispatchPendingItemsToInsert();
- if (!m_filteredItems.isEmpty()) {
+ KFileItemList itemsToRemove = items;
+ if (m_requestRole[ExpansionLevelRole] && m_rootExpansionLevel >= 0) {
+ // Assure that removing a parent item also results in removing all children
foreach (const KFileItem& item, items) {
+ itemsToRemove.append(childItems(item));
+ }
+ }
+
+ if (!m_filteredItems.isEmpty()) {
+ foreach (const KFileItem& item, itemsToRemove) {
m_filteredItems.remove(item);
}
}
- removeItems(items);
+ removeItems(itemsToRemove);
}
void KFileItemModel::slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items)
m_resortAllItemsTimer->stop();
m_pendingItemsToInsert.clear();
- m_rootExpansionLevel = -1;
+ m_rootExpansionLevel = UninitializedRootExpansionLevel;
const int removedCount = m_itemData.count();
if (removedCount > 0) {
m_groups.clear();
- QList<ItemData*> sortedItems = createItemDataList(items);
+ QList<ItemData*> sortedItems;
+ sortedItems.reserve(items.count());
+ foreach (const KFileItem& item, items) {
+ const int index = m_items.value(item.url(), -1);
+ if (index >= 0) {
+ sortedItems.append(m_itemData.at(index));
+ }
+ }
sort(sortedItems.begin(), sortedItems.end());
QList<int> indexesToRemove;
++removedCount;
++targetIndex;
}
- qDeleteAll(sortedItems);
- sortedItems.clear();
// Delete the items
for (int i = indexesToRemove.count() - 1; i >= 0; --i) {
}
if (count() <= 0) {
- m_rootExpansionLevel = -1;
+ m_rootExpansionLevel = UninitializedRootExpansionLevel;
}
itemRanges << KItemRange(removedAtIndex, removedCount);
ItemData* itemData = new ItemData();
itemData->item = item;
itemData->values = retrieveData(item);
+ itemData->parent = 0;
+
+ const bool determineParent = m_requestRole[ExpansionLevelRole]
+ && itemData->values["expansionLevel"].toInt() > 0;
+ if (determineParent) {
+ KUrl parentUrl = item.url().upUrl();
+ parentUrl.adjustPath(KUrl::RemoveTrailingSlash);
+ const int parentIndex = m_items.value(parentUrl, -1);
+ if (parentIndex >= 0) {
+ itemData->parent = m_itemData.at(parentIndex);
+ } else {
+ kWarning() << "Parent item not found for" << item.url();
+ }
+ }
+
itemDataList.append(itemData);
}
Q_ASSERT(m_rootExpansionLevel >= 0);
removeItems(expandedItems);
- m_rootExpansionLevel = -1;
+ m_rootExpansionLevel = UninitializedRootExpansionLevel;
m_expandedUrls.clear();
}
rolesHash.insert("rating", RatingRole);
rolesHash.insert("isDir", IsDirRole);
rolesHash.insert("isExpanded", IsExpandedRole);
+ rolesHash.insert("isExpandable", IsExpandableRole);
rolesHash.insert("expansionLevel", ExpansionLevelRole);
}
return rolesHash.value(role, NoRole);
}
if (m_requestRole[PathRole]) {
- data.insert("path", item.localPath());
+ if (item.url().protocol() == QLatin1String("trash")) {
+ const KIO::UDSEntry udsEntry = item.entry();
+ data.insert("path", udsEntry.stringValue(KIO::UDSEntry::UDS_EXTRA));
+ } else {
+ data.insert("path", item.localPath());
+ }
}
if (m_requestRole[IsExpandedRole]) {
data.insert("isExpanded", false);
}
+ if (m_requestRole[IsExpandableRole]) {
+ data.insert("isExpandable", item.isDir() && item.url() == item.targetUrl());
+ }
+
if (m_requestRole[ExpansionLevelRole]) {
- if (m_rootExpansionLevel < 0 && m_dirLister.data()) {
- const QString rootDir = m_dirLister.data()->url().directory(KUrl::AppendTrailingSlash);
- m_rootExpansionLevel = rootDir.count('/');
- if (m_rootExpansionLevel == 1) {
- // Special case: The root is already reached and no parent is available
- --m_rootExpansionLevel;
+ if (m_rootExpansionLevel == UninitializedRootExpansionLevel && m_dirLister.data()) {
+ const KUrl rootUrl = m_dirLister.data()->url();
+ const QString protocol = rootUrl.protocol();
+ const bool forceRootExpansionLevel = (protocol == QLatin1String("trash") ||
+ protocol == QLatin1String("nepomuk") ||
+ protocol == QLatin1String("remote") ||
+ protocol.contains(QLatin1String("search")));
+ if (forceRootExpansionLevel) {
+ m_rootExpansionLevel = ForceRootExpansionLevel;
+ } else {
+ const QString rootDir = rootUrl.directory(KUrl::AppendTrailingSlash);
+ m_rootExpansionLevel = rootDir.count('/');
+ if (m_rootExpansionLevel == 1) {
+ // Special case: The root is already reached and no parent is available
+ --m_rootExpansionLevel;
+ }
}
}
- const QString dir = item.url().directory(KUrl::AppendTrailingSlash);
- const int level = dir.count('/') - m_rootExpansionLevel - 1;
- data.insert("expansionLevel", level);
+
+ if (m_rootExpansionLevel == ForceRootExpansionLevel) {
+ data.insert("expansionLevel", -1);
+ } else {
+ const QString dir = item.url().directory(KUrl::AppendTrailingSlash);
+ const int level = dir.count('/') - m_rootExpansionLevel - 1;
+ data.insert("expansionLevel", level);
+ }
}
if (item.isMimeTypeKnown()) {
bool KFileItemModel::lessThan(const ItemData* a, const ItemData* b) const
{
- const KFileItem& itemA = a->item;
- const KFileItem& itemB = b->item;
-
int result = 0;
if (m_rootExpansionLevel >= 0) {
- result = expansionLevelsCompare(itemA, itemB);
+ result = expansionLevelsCompare(a, b);
if (result != 0) {
// The items have parents with different expansion levels
return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
}
if (m_sortFoldersFirst || m_sortRole == SizeRole) {
- const bool isDirA = itemA.isDir();
- const bool isDirB = itemB.isDir();
+ const bool isDirA = a->item.isDir();
+ const bool isDirB = b->item.isDir();
if (isDirA && !isDirB) {
return true;
} else if (!isDirA && isDirB) {
}
}
+ result = sortRoleCompare(a, b);
+
+ return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
+}
+
+int KFileItemModel::sortRoleCompare(const ItemData* a, const ItemData* b) const
+{
+ const KFileItem& itemA = a->item;
+ const KFileItem& itemB = b->item;
+
+ int result = 0;
+
switch (m_sortRole) {
- case NameRole: {
- result = stringCompare(itemA.text(), itemB.text());
- if (result == 0) {
- // KFileItem::text() may not be unique in case UDS_DISPLAY_NAME is used
- result = stringCompare(itemA.name(m_caseSensitivity == Qt::CaseInsensitive),
- itemB.name(m_caseSensitivity == Qt::CaseInsensitive));
- }
+ case NameRole:
+ // The name role is handled as default fallback after the switch
break;
- }
case DateRole: {
const KDateTime dateTimeA = itemA.time(KFileItem::ModificationTime);
result = QString::compare(a->values.value("comment").toString(),
b->values.value("comment").toString());
break;
- }
+ }
case TagsRole: {
result = QString::compare(a->values.value("tags").toString(),
b->values.value("tags").toString());
break;
- }
-
+ }
+
case RatingRole: {
result = a->values.value("rating").toInt() - b->values.value("rating").toInt();
break;
break;
}
- if (result == 0) {
- // It must be assured that the sort order is always unique even if two values have been
- // equal. In this case a comparison of the URL is done which is unique in all cases
- // within KDirLister.
- result = QString::compare(itemA.url().url(), itemB.url().url(), Qt::CaseSensitive);
+ if (result != 0) {
+ // The current sort role was sufficient to define an order
+ return result;
}
- return (sortOrder() == Qt::AscendingOrder) ? result < 0 : result > 0;
+ // Fallback #1: Compare the text of the items
+ result = stringCompare(itemA.text(), itemB.text());
+ if (result != 0) {
+ return result;
+ }
+
+ // Fallback #2: KFileItem::text() may not be unique in case UDS_DISPLAY_NAME is used
+ result = stringCompare(itemA.name(m_caseSensitivity == Qt::CaseInsensitive),
+ itemB.name(m_caseSensitivity == Qt::CaseInsensitive));
+ if (result != 0) {
+ return result;
+ }
+
+ // Fallback #3: It must be assured that the sort order is always unique even if two values have been
+ // equal. In this case a comparison of the URL is done which is unique in all cases
+ // within KDirLister.
+ return QString::compare(itemA.url().url(), itemB.url().url(), Qt::CaseSensitive);
}
void KFileItemModel::sort(QList<ItemData*>::iterator begin,
: QString::compare(a, b, Qt::CaseSensitive);
}
-int KFileItemModel::expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const
+int KFileItemModel::expansionLevelsCompare(const ItemData* a, const ItemData* b) const
{
- const KUrl urlA = a.url();
- const KUrl urlB = b.url();
+ const KUrl urlA = a->item.url();
+ const KUrl urlB = b->item.url();
if (urlA.directory() == urlB.directory()) {
// Both items have the same directory as parent
return 0;
// Check whether one item is the parent of the other item
if (urlA.isParentOf(urlB)) {
- return -1;
+ return (sortOrder() == Qt::AscendingOrder) ? -1 : +1;
} else if (urlB.isParentOf(urlA)) {
- return +1;
+ return (sortOrder() == Qt::AscendingOrder) ? +1 : -1;
}
// Determine the maximum common path of both items and
// Determine the first sub-path after the common path and
// check whether it represents a directory or already a file
bool isDirA = true;
- const QString subPathA = subPath(a, pathA, index, &isDirA);
+ const QString subPathA = subPath(a->item, pathA, index, &isDirA);
bool isDirB = true;
- const QString subPathB = subPath(b, pathB, index, &isDirB);
+ const QString subPathB = subPath(b->item, pathB, index, &isDirB);
if (isDirA && !isDirB) {
- return -1;
+ return (sortOrder() == Qt::AscendingOrder) ? -1 : +1;
} else if (!isDirA && isDirB) {
- return +1;
+ return (sortOrder() == Qt::AscendingOrder) ? +1 : -1;
+ }
+
+ // Compare the items of the parents that represent the first
+ // different path after the common path.
+ const KUrl parentUrlA(pathA.left(index) + subPathA);
+ const KUrl parentUrlB(pathB.left(index) + subPathB);
+
+ const ItemData* parentA = a;
+ while (parentA && parentA->item.url() != parentUrlA) {
+ parentA = parentA->parent;
}
- return stringCompare(subPathA, subPathB);
+ const ItemData* parentB = b;
+ while (parentB && parentB->item.url() != parentUrlB) {
+ parentB = parentB->parent;
+ }
+
+ if (parentA && parentB) {
+ return sortRoleCompare(parentA, parentB);
+ }
+
+ kWarning() << "Child items without parent detected:" << a->item.url() << b->item.url();
+ return QString::compare(urlA.url(), urlB.url(), Qt::CaseSensitive);
}
QString KFileItemModel::subPath(const KFileItem& item,
// Use the first character of the name as group indication
QChar newFirstChar = name.at(0).toUpper();
if (newFirstChar == QLatin1Char('~') && name.length() > 1) {
- newFirstChar = name.at(1);
+ newFirstChar = name.at(1).toUpper();
}
if (firstChar != newFirstChar) {
return groups;
}
-bool KFileItemModel::matchesNameFilter(const KFileItem& item) const
+KFileItemList KFileItemModel::childItems(const KFileItem& item) const
{
- // TODO #1: A performance improvement would be possible by caching m_nameFilter.toLower().
- // Before adding yet-another-member it should be checked whether it brings a noticable
- // improvement at all.
+ KFileItemList items;
+
+ int index = m_items.value(item.url(), -1);
+ if (index >= 0) {
+ const int parentLevel = m_itemData.at(index)->values.value("expansionLevel").toInt();
+ ++index;
+ while (index < m_itemData.count() && m_itemData.at(index)->values.value("expansionLevel").toInt() > parentLevel) {
+ items.append(m_itemData.at(index)->item);
+ ++index;
+ }
+ }
- // TODO #2: If the user entered a '*' use a regular expression
- const QString itemText = item.text().toLower();
- return itemText.contains(m_nameFilter.toLower());
+ return items;
}
#include "kfileitemmodel.moc"