dolphinsortfilterproxymodel.cpp 16.3 KB
Newer Older
1
/***************************************************************************
2
3
4
 *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
 *   Copyright (C) 2006 by Dominic Battre <dominic@battre.de>              *
 *   Copyright (C) 2006 by Martin Pool <mbp@canonical.com>                 *
5
 *   Copyright (C) 2007 by Rafael Fernández López <ereslibre@gmail.com>    *
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
 ***************************************************************************/
22
23
24
25
26

#include "dolphinsortfilterproxymodel.h"

#include <kdirmodel.h>
#include <kfileitem.h>
27
#include <kdatetime.h>
28

Peter Penz's avatar
Peter Penz committed
29
static const int dolphinMapSize = 7;
30
static int dolphinViewToDirModelColumn[] =
Peter Penz's avatar
Peter Penz committed
31
32
33
34
35
36
37
38
39
{
    KDirModel::Name,         // DolphinView::SortByName
    KDirModel::Size,         // DolphinView::SortBySize
    KDirModel::ModifiedTime, // DolphinView::SortByDate
    KDirModel::Permissions,  // DolphinView::SortByPermissions
    KDirModel::Owner,        // DolphinView::SortByOwner
    KDirModel::Group,        // DolphinView::SortByGroup
    KDirModel::Type          // DolphinView::SortByType
};
40
41

static DolphinView::Sorting dirModelColumnToDolphinView[] =
Peter Penz's avatar
Peter Penz committed
42
43
44
45
46
47
48
49
50
{
    DolphinView::SortByName,        // KDirModel::Name
    DolphinView::SortBySize,        // KDirModel::Size
    DolphinView::SortByDate,        // KDirModel::ModifiedTime
    DolphinView::SortByPermissions, // KDirModel::Permissions
    DolphinView::SortByOwner,       // KDirModel::Owner
    DolphinView::SortByGroup,       // KDirModel::Group
    DolphinView::SortByType         // KDirModel::Type
};
51
52


53
DolphinSortFilterProxyModel::DolphinSortFilterProxyModel(QObject* parent) :
54
    KSortFilterProxyModel(parent),
55
56
57
    m_sortColumn(0),
    m_sorting(DolphinView::SortByName),
    m_sortOrder(Qt::AscendingOrder)
58
{
59
60
    setDynamicSortFilter(true);

61
    // sort by the user visible string for now
62
    setSortRole(DolphinView::SortByName);
63
    setSortCaseSensitivity(Qt::CaseInsensitive);
64
    sort(KDirModel::Name, Qt::AscendingOrder);
65
66
67
}

DolphinSortFilterProxyModel::~DolphinSortFilterProxyModel()
68
69
{
}
70
71
72

void DolphinSortFilterProxyModel::setSorting(DolphinView::Sorting sorting)
{
73
74
    // Update the sort column by mapping DolpginView::Sorting to
    // KDirModel::ModelColumns. We will keep the sortOrder.
75
    Q_ASSERT(static_cast<int>(sorting) >= 0 && static_cast<int>(sorting) < dolphinMapSize);
76
    sort(dolphinViewToDirModelColumn[static_cast<int>(sorting)],
77
         m_sortOrder);
78
79
}

80
81
82
83
84
85
void DolphinSortFilterProxyModel::setSortOrder(Qt::SortOrder sortOrder)
{
    // change the sort order by keeping the current column
    sort(dolphinViewToDirModelColumn[m_sorting], sortOrder);
}

86
87
void DolphinSortFilterProxyModel::sort(int column, Qt::SortOrder sortOrder)
{
88
    m_sortColumn = column;
89
    m_sortOrder = sortOrder;
90
    m_sorting = (column >= 0) && (column < dolphinMapSize) ?
91
92
                dirModelColumnToDolphinView[column]  :
                DolphinView::SortByName;
93
    setSortRole(dirModelColumnToDolphinView[column]);
94
    KSortFilterProxyModel::sort(column, sortOrder);
95
96
}

97
98
99
100
101
102
103
104
105
106
107
108
bool DolphinSortFilterProxyModel::hasChildren(const QModelIndex& parent) const
{
    const QModelIndex sourceParent = mapToSource(parent);
    return sourceModel()->hasChildren(sourceParent);
}

bool DolphinSortFilterProxyModel::canFetchMore(const QModelIndex& parent) const
{
    const QModelIndex sourceParent = mapToSource(parent);
    return sourceModel()->canFetchMore(sourceParent);
}

109
110
DolphinView::Sorting DolphinSortFilterProxyModel::sortingForColumn(int column)
{
111
    if ((column >= 0) && (column < dolphinMapSize)) {
112
113
114
115
116
        return dirModelColumnToDolphinView[column];
    }
    return DolphinView::SortByName;
}

117
118
119
120
121
bool DolphinSortFilterProxyModel::lessThanGeneralPurpose(const QModelIndex &left,
                                                         const QModelIndex &right) const
{
    KDirModel* dirModel = static_cast<KDirModel*>(sourceModel());

122
123
    const KFileItem* leftFileItem  = dirModel->itemForIndex(left);
    const KFileItem* rightFileItem = dirModel->itemForIndex(right);
124

125
    switch (sortRole()) {
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
    case DolphinView::SortByName: {
        QString leftFileName(leftFileItem->name());
        if (leftFileName.at(0) == '.') {
            leftFileName = leftFileName.mid(1);
        }

        QString rightFileName(rightFileItem->name());
        if (rightFileName.at(0) == '.') {
            rightFileName = rightFileName.mid(1);
        }

        // We don't care about case for building categories. We also don't
        // want here to compare by a natural comparison.
        return naturalCompare(leftFileName, rightFileName) < 0;
    }
141

142
143
144
145
    case DolphinView::SortBySize:
        // If we are sorting by size, show folders first. We will sort them
        // correctly later.
        return leftFileItem->isDir() && !rightFileItem->isDir();
146

147
148
149
150
151
152
    case DolphinView::SortByDate: {
        KDateTime leftTime, rightTime;
        leftTime.setTime_t(leftFileItem->time(KIO::UDS_MODIFICATION_TIME));
        rightTime.setTime_t(rightFileItem->time(KIO::UDS_MODIFICATION_TIME));
        return leftTime > rightTime;
    }
153

154
155
156
157
    case DolphinView::SortByPermissions: {
        return naturalCompare(leftFileItem->permissionsString(),
                            rightFileItem->permissionsString()) < 0;
    }
158

159
160
161
162
    case DolphinView::SortByOwner: {
        return naturalCompare(leftFileItem->user().toLower(),
                              rightFileItem->user().toLower()) < 0;
    }
163

164
165
166
167
    case DolphinView::SortByGroup: {
        return naturalCompare(leftFileItem->group().toLower(),
                              rightFileItem->group().toLower()) < 0;
    }
168

169
170
171
172
173
174
175
176
    case DolphinView::SortByType: {
        // If we are sorting by size, show folders first. We will sort them
        // correctly later
        if (leftFileItem->isDir() && !rightFileItem->isDir()) {
            return true;
        } else if (!leftFileItem->isDir() && rightFileItem->isDir()) {
            return false;
        }
177

178
179
180
        return naturalCompare(leftFileItem->mimeComment().toLower(),
                              rightFileItem->mimeComment().toLower()) < 0;
    }
181
    }
182
183
}

184
bool DolphinSortFilterProxyModel::lessThan(const QModelIndex& left,
185
                                           const QModelIndex& right) const
186
{
187
188
    KDirModel* dirModel = static_cast<KDirModel*>(sourceModel());

189
190
    QVariant leftData  = dirModel->data(left, dolphinViewToDirModelColumn[sortRole()]);
    QVariant rightData = dirModel->data(right, dolphinViewToDirModelColumn[sortRole()]);
191

192
193
194
    const KFileItem *leftFileItem  = dirModel->itemForIndex(left);
    const KFileItem *rightFileItem = dirModel->itemForIndex(right);

195
196
197
    // On our priority, folders go above regular files
    if (leftFileItem->isDir() && !rightFileItem->isDir()) {
        return true;
198
    } else if (!leftFileItem->isDir() && rightFileItem->isDir()) {
199
        return false;
200
201
    }

202
203
204
205
    // Hidden elements go before visible ones, if they both are
    // folders or files
    if (leftFileItem->isHidden() && !rightFileItem->isHidden()) {
        return true;
206
    } else if (!leftFileItem->isHidden() && rightFileItem->isHidden()) {
207
208
        return false;
    }
209

210
    switch (sortRole()) {
211
212
213
214
    case DolphinView::SortByName: {
        // So we are in the same priority, what counts now is their names
        QString leftValueString = leftData.toString();
        QString rightValueString = rightData.toString();
215

216
217
218
        return sortCaseSensitivity() ? (naturalCompare(leftValueString, rightValueString) < 0) :
                (naturalCompare(leftValueString.toLower(), rightValueString.toLower()) < 0);
    }
219

220
221
222
223
224
225
    case DolphinView::SortBySize: {
        // If we have two folders, what we have to measure is the number of
        // items that contains each other
        if (leftFileItem->isDir() && rightFileItem->isDir()) {
            QVariant leftValue = dirModel->data(left, KDirModel::ChildCountRole);
            int leftCount = leftValue.type() == QVariant::Int ? leftValue.toInt() : KDirModel::ChildCountUnknown;
226

227
228
            QVariant rightValue = dirModel->data(right, KDirModel::ChildCountRole);
            int rightCount = rightValue.type() == QVariant::Int ? rightValue.toInt() : KDirModel::ChildCountUnknown;
229

230
231
232
233
            // In the case they two have the same child items, we sort them by
            // their names. So we have always everything ordered. We also check
            // if we are taking in count their cases
            if (leftCount == rightCount) {
234
                return sortCaseSensitivity() ? (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
235
                        (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
236
            }
237

238
239
240
241
            // If they had different number of items, we sort them depending
            // on how many items had each other
            return leftCount < rightCount;
        }
242

243
244
245
246
247
248
        // If what we are measuring is two files and they have the same size,
        // sort them by their file names
        if (leftFileItem->size() == rightFileItem->size()) {
            return sortCaseSensitivity() ? (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                    (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }
249

250
251
252
        // If their sizes are different, sort them by their sizes, as expected
        return leftFileItem->size() < rightFileItem->size();
    }
253

254
255
256
257
    case DolphinView::SortByDate: {
        KDateTime leftTime, rightTime;
        leftTime.setTime_t(leftFileItem->time(KIO::UDS_MODIFICATION_TIME));
        rightTime.setTime_t(rightFileItem->time(KIO::UDS_MODIFICATION_TIME));
258

259
260
261
262
263
        if (leftTime == rightTime) {
            return sortCaseSensitivity() ?
                   (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                   (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }
264

265
266
        return leftTime > rightTime;
    }
267

268
269
270
271
272
273
    case DolphinView::SortByPermissions: {
        if (leftFileItem->permissionsString() == rightFileItem->permissionsString()) {
            return sortCaseSensitivity() ?
                   (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                   (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }
274

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
        return naturalCompare(leftFileItem->permissionsString(),
                              rightFileItem->permissionsString()) < 0;
    }

    case DolphinView::SortByOwner: {
        if (leftFileItem->user() == rightFileItem->user()) {
            return sortCaseSensitivity() ?
                   (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                   (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }

        return naturalCompare(leftFileItem->user(), rightFileItem->user()) < 0;
    }

    case DolphinView::SortByGroup: {
        if (leftFileItem->group() == rightFileItem->group()) {
            return sortCaseSensitivity() ? (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                    (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }
294

295
296
297
298
299
300
301
302
303
304
305
306
307
308
        return naturalCompare(leftFileItem->group(),
                              rightFileItem->group()) < 0;
    }

    case DolphinView::SortByType: {
        if (leftFileItem->mimetype() == rightFileItem->mimetype()) {
            return sortCaseSensitivity() ?
                   (naturalCompare(leftFileItem->name(), rightFileItem->name()) < 0) :
                   (naturalCompare(leftFileItem->name().toLower(), rightFileItem->name().toLower()) < 0);
        }

        return naturalCompare(leftFileItem->mimeComment(),
                              rightFileItem->mimeComment()) < 0;
    }
309
    }
310
311
312
313

    // We have set a SortRole and trust the ProxyModel to do
    // the right thing for now.
    return QSortFilterProxyModel::lessThan(left, right);
314
315
}

316
int DolphinSortFilterProxyModel::naturalCompare(const QString& a,
317
                                                const QString& b)
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
{
    // This method chops the input a and b into pieces of
    // digits and non-digits (a1.05 becomes a | 1 | . | 05)
    // and compares these pieces of a and b to each other
    // (first with first, second with second, ...).
    //
    // This is based on the natural sort order code code by Martin Pool
    // http://sourcefrog.net/projects/natsort/
    // Martin Pool agreed to license this under LGPL or GPL.

    const QChar* currA = a.unicode(); // iterator over a
    const QChar* currB = b.unicode(); // iterator over b

    if (currA == currB) {
        return 0;
    }

    const QChar* begSeqA = currA; // beginning of a new character sequence of a
    const QChar* begSeqB = currB;

    while (!currA->isNull() && !currB->isNull()) {
        // find sequence of characters ending at the first non-character
        while (!currA->isNull() && !currA->isDigit()) {
            ++currA;
        }

        while (!currB->isNull() && !currB->isDigit()) {
            ++currB;
        }

        // compare these sequences
349
350
351
        const QString subA(begSeqA, currA - begSeqA);
        const QString subB(begSeqB, currB - begSeqB);
        const int cmp = QString::localeAwareCompare(subA, subB);
352
353
354
355
356
357
358
359
360
361
362
        if (cmp != 0) {
            return cmp;
        }

        if (currA->isNull() || currB->isNull()) {
            break;
        }

        // now some digits follow...
        if ((*currA == '0') || (*currB == '0')) {
            // one digit-sequence starts with 0 -> assume we are in a fraction part
363
            // do left aligned comparison (numbers are considered left aligned)
364
            while (1) {
365
366
                if (!currA->isDigit() && !currB->isDigit()) {
                    break;
367
                } else if (!currA->isDigit()) {
368
                    return -1;
369
370
371
                } else if (!currB->isDigit()) {
                    return + 1;
                } else if (*currA < *currB) {
372
                    return -1;
373
374
                } else if (*currA > *currB) {
                    return + 1;
375
376
377
378
                }
                ++currA;
                ++currB;
            }
379
        } else {
380
381
382
383
            // No digit-sequence starts with 0 -> assume we are looking at some integer
            // do right aligned comparison.
            //
            // The longest run of digits wins. That aside, the greatest
384
            // value wins, but we can't know that it will until we've scanned
385
            // both numbers to know that they have the same magnitude.
386

387
            int weight = 0;
388
389
            while (1) {
                if (!currA->isDigit() && !currB->isDigit()) {
390
391
                    if (weight != 0) {
                        return weight;
392
393
                    }
                    break;
394
                } else if (!currA->isDigit()) {
395
                    return -1;
396
397
398
                } else if (!currB->isDigit()) {
                    return + 1;
                } else if ((*currA < *currB) && (weight == 0)) {
399
                    weight = -1;
400
401
                } else if ((*currA > *currB) && (weight == 0)) {
                    weight = + 1;
402
403
404
405
406
407
408
409
410
411
412
413
414
415
                }
                ++currA;
                ++currB;
            }
        }

        begSeqA = currA;
        begSeqB = currB;
    }

    if (currA->isNull() && currB->isNull()) {
        return 0;
    }

416
    return currA->isNull() ? -1 : + 1;
417
418
}

419
#include "dolphinsortfilterproxymodel.moc"