summaryrefslogtreecommitdiffstats
path: root/src/organizer/qorganizeritemchangeset.cpp
blob: 27e919ed7eacaf4e1dfc5ea168d9681f5a0819ef (plain)
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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtOrganizer module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qorganizeritemchangeset.h"
#include "qorganizeritemchangeset_p.h"

#include "qorganizermanagerengine.h"

QT_BEGIN_NAMESPACE_ORGANIZER

/*!
    \class QOrganizerItemChangeSet
    \brief The QOrganizerItemChangeSet class provides a simple API to simplify the emission of
           state-change signals for items from QOrganizerManagerEngine implementations.
    \inmodule QtOrganizer
    \ingroup organizer-backends

    This class should only be used by backend developers.
 */

/*!
   \typedef QOrganizerItemChangeSet::ItemChangeList

   This type describes a set of item changes, where each item whose
   ID is listed in \c second is subject to a change that affects some or
   all of the detail types listed in \c first.

   Note that change grouping is of items affected by equivalent changes,
   rather than of multiple changes affecting the same item.

   \code
        foreach (QOrganizerItemChangeSet::ItemChangeList changeList, set.changedItems()) {
            if (changeList.first.contains(QOrganizerItemDetail::TypeDescription)) {
                qDebug() << "Item IDs with description changes:" << changeList.second;
            }
        }
   \endcode

   \sa QOrganizerItemChangeSet::changedItems()
 */

/*!
    Constructs a new change set.
 */
QOrganizerItemChangeSet::QOrganizerItemChangeSet()
    : d(new QOrganizerItemChangeSetData)
{
}

/*!
    Constructs a copy of the \a other change set.
 */
QOrganizerItemChangeSet::QOrganizerItemChangeSet(const QOrganizerItemChangeSet &other)
    : d(other.d)
{
}

/*!
    Frees the memory used by this change set.
 */
QOrganizerItemChangeSet::~QOrganizerItemChangeSet()
{
}

/*!
    Assigns this change set to be equal to \a other.
 */
QOrganizerItemChangeSet &QOrganizerItemChangeSet::operator=(const QOrganizerItemChangeSet &other)
{
    d = other.d;
    return *this;
}

/*!
    Sets the data changed flag to \a dataChanged.

    If this is set to true prior to calling emitSignals(), only the QOrganizerManagerEngine::dataChanged()
    signal will be emitted; otherwise, the appropriate finer-grained signals will be emitted.
 */
void QOrganizerItemChangeSet::setDataChanged(bool dataChanged)
{
    d->m_dataChanged = dataChanged;
}

/*!
    Returns the value of the data changed flag.
 */
bool QOrganizerItemChangeSet::dataChanged() const
{
    return d->m_dataChanged;
}

/*!
    Returns the set of IDs of organizer items which have been added to the database.
 */
QSet<QOrganizerItemId> QOrganizerItemChangeSet::addedItems() const
{
    return d->m_addedItems;
}

/*!
    Inserts the given \a itemId into the set of ids of organizer items which have been added to the
    database.
 */
void QOrganizerItemChangeSet::insertAddedItem(const QOrganizerItemId &itemId)
{
    d->m_addedItems.insert(itemId);
    d->m_modifiedItems.append(QPair<QOrganizerItemId, QOrganizerManager::Operation>(itemId, QOrganizerManager::Add));
}

/*!
    Inserts each of the given \a itemIds into the set of IDs of organizer items which have been added
    to the database.
 */
void QOrganizerItemChangeSet::insertAddedItems(const QList<QOrganizerItemId> &itemIds)
{
    foreach (const QOrganizerItemId &id, itemIds) {
        d->m_addedItems.insert(id);
        d->m_modifiedItems.append(QPair<QOrganizerItemId, QOrganizerManager::Operation>(id, QOrganizerManager::Add));
    }
}

/*!
    Clears the set of IDs of organizer items which have been added to the database.
 */
void QOrganizerItemChangeSet::clearAddedItems()
{
    d->m_addedItems.clear();
}

/*!
    Returns a list of ItemChangeLists describing which items have been
    changed in the database, and what details of those items have changed.

 */
QList<QOrganizerItemChangeSet::ItemChangeList> QOrganizerItemChangeSet::changedItems() const
{
    return d->m_changedItems;
}

/*!
    Inserts the given item ID \a itemId into the set of IDs of organizer items which have been changed in
    the database, with the changes described by \a typesChanged.
 */
void QOrganizerItemChangeSet::insertChangedItem(const QOrganizerItemId &itemId, const QList<QOrganizerItemDetail::DetailType> &typesChanged)
{
    insertChangedItems(QList<QOrganizerItemId>() << itemId, typesChanged);
}

/*!
    Inserts each of the itemIDs listed in \a itemIds into the set of IDs of organizer items which have been
    changed in the database, with the changes described by \a typesChanged.
 */
void QOrganizerItemChangeSet::insertChangedItems(const QList<QOrganizerItemId> &changedItemIds, const QList<QOrganizerItemDetail::DetailType> &typesChanged)
{
    // Sort and de-duplicate the IDs and change types
    QList<QOrganizerItemId> itemIds(changedItemIds);
    std::sort(itemIds.begin(), itemIds.end());
    {
        QList<QOrganizerItemId>::iterator iit = std::unique(itemIds.begin(), itemIds.end());
        while (iit != itemIds.end()) {
            iit = itemIds.erase(iit);
        }
    }

    QList<QOrganizerItemDetail::DetailType> changeSet(typesChanged);
    std::sort(changeSet.begin(), changeSet.end());
    {
        QList<QOrganizerItemDetail::DetailType>::iterator cit = std::unique(changeSet.begin(), changeSet.end());
        while (cit != changeSet.end()) {
            cit = changeSet.erase(cit);
        }
    }

    // Add these items to the list of items that match this change set
    QList<ItemChangeList>::iterator it = d->m_changedItems.begin(), end = d->m_changedItems.end();
    for ( ; it != end; ++it) {
        if ((*it).first == changeSet) {
            break;
        }
    }
    if (it == end) {
        // Add a list for this set of changes
        d->m_changedItems.append(qMakePair(changeSet, itemIds));
    } else {
        QList<QOrganizerItemId> &changedIds((*it).second);
        QList<QOrganizerItemId>::iterator iit = changedIds.begin();

        foreach (const QOrganizerItemId &itemId, itemIds) {
            // Add this ID if not yet present
            iit = std::lower_bound(iit, changedIds.end(), itemId);
            if (iit == changedIds.end() || *iit != itemId) {
                iit = changedIds.insert(iit, itemId);
            }
        }
    }

    // These items are all now modified
    foreach (const QOrganizerItemId &id, itemIds)
        d->m_modifiedItems.append(QPair<QOrganizerItemId, QOrganizerManager::Operation>(id, QOrganizerManager::Change));
}

/*!
    Clears the set of IDs of organizer items which have been changed in the database.
 */
void QOrganizerItemChangeSet::clearChangedItems()
{
    d->m_changedItems.clear();
}

/*!
    Returns the set of IDs of organizer items which have been removed from the database.
 */
QSet<QOrganizerItemId> QOrganizerItemChangeSet::removedItems() const
{
    return d->m_removedItems;
}

/*!
    Inserts the given \a itemId into the set of IDs of organizer items which have been removed from
    the database.
 */
void QOrganizerItemChangeSet::insertRemovedItem(const QOrganizerItemId &itemId)
{
    d->m_removedItems.insert(itemId);
    d->m_modifiedItems.append(QPair<QOrganizerItemId, QOrganizerManager::Operation>(itemId, QOrganizerManager::Remove));
}

/*!
    Inserts each of the given \a itemIds into the set of IDs of organizer items which have been
    removed from the database.
 */
void QOrganizerItemChangeSet::insertRemovedItems(const QList<QOrganizerItemId> &itemIds)
{
    foreach (const QOrganizerItemId &id, itemIds) {
        d->m_removedItems.insert(id);
        d->m_modifiedItems.append(QPair<QOrganizerItemId, QOrganizerManager::Operation>(id, QOrganizerManager::Remove));
    }
}

/*!
    Clears the set of IDs of organizer items which have been removed from the database.
 */
void QOrganizerItemChangeSet::clearRemovedItems()
{
    d->m_removedItems.clear();
}

/*!
   Returns the list of ids of organizer items which have been added, changed or removed from
   the database. The list includes information about which database operation was done. The ids and
   operations are ordered so that the first operation is first in the list.
 */
QList<QPair<QOrganizerItemId, QOrganizerManager::Operation> > QOrganizerItemChangeSet::modifiedItems() const
{
    return d->m_modifiedItems;
}

/*!
  Clears the list of ids of organizer items which have been added, changed or removed from the database
 */
void QOrganizerItemChangeSet::clearModifiedItems()
{
    d->m_modifiedItems.clear();
}

/*!
    Clears all flags and sets of IDs in this change set.
 */
void QOrganizerItemChangeSet::clearAll()
{
    d->m_dataChanged = false;
    d->m_addedItems.clear();
    d->m_changedItems.clear();
    d->m_removedItems.clear();
    d->m_modifiedItems.clear();
}

/*!
    Emits the appropriate signals from the given \a engine given the state of the change set. Note
    that the flags and sets of IDs are not cleared after signals are emitted.
 */
void QOrganizerItemChangeSet::emitSignals(QOrganizerManagerEngine *engine) const
{
    if (!engine)
        return;

    if (d->m_dataChanged) {
        emit engine->dataChanged();
    } else {
        if (!d->m_addedItems.isEmpty())
            emit engine->itemsAdded(d->m_addedItems.values());
        if (!d->m_changedItems.isEmpty()) {
            QList<ItemChangeList>::const_iterator it = d->m_changedItems.constBegin(), end = d->m_changedItems.constEnd();
            for ( ; it != end; ++it)
                emit engine->itemsChanged((*it).second, (*it).first);
        }
        if (!d->m_removedItems.isEmpty())
            emit engine->itemsRemoved(d->m_removedItems.values());
        if (!d->m_modifiedItems.isEmpty())
            emit engine->itemsModified(d->m_modifiedItems);
    }
}

QT_END_NAMESPACE_ORGANIZER