/usr/include/akonadi/private/imapset_p.h is in libakonadi-dev 1.7.2-0ubuntu1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library 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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_IMAPSET_P_H
#define AKONADI_IMAPSET_P_H
#include "akonadiprotocolinternals_export.h"
#include <QtCore/QByteArray>
#include <QtCore/QDebug>
#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtCore/QSharedDataPointer>
namespace Akonadi {
/**
Represents a single interval in an ImapSet.
This class is implicitly shared.
*/
class AKONADIPROTOCOLINTERNALS_EXPORT ImapInterval
{
public:
/**
* Describes the ids stored in the interval.
*/
typedef qint64 Id;
/**
A list of ImapInterval objects.
*/
typedef QList<ImapInterval> List;
/**
Constructs an interval that covers all positive numbers.
*/
ImapInterval();
/**
Copy constructor.
*/
ImapInterval( const ImapInterval &other );
/**
Create a new interval.
@param begin The begin of the interval.
@param end Keep default (0) to just set the interval begin
*/
explicit ImapInterval( Id begin, Id end = 0 );
/**
Destructor.
*/
~ImapInterval();
/**
Assignment operator.
*/
ImapInterval& operator=( const ImapInterval &other );
/**
Comparison operator.
*/
bool operator==( const ImapInterval &other ) const;
/**
Returns the size of this interval.
Size is only defined for finite intervals.
*/
Id size() const;
/**
Returns true if this interval has a defined begin.
*/
bool hasDefinedBegin() const;
/**
Returns the begin of this interval. The value is the smallest value part of the interval.
Only valid if begin is defined.
*/
Id begin() const;
/**
Returns true if this intercal has been defined.
*/
bool hasDefinedEnd() const;
/**
Returns the end of this interval. This value is the largest value part of the interval.
Only valid if hasDefinedEnd() returned true.
*/
Id end() const;
/**
Sets the begin of the interval.
*/
void setBegin( Id value );
/**
Sets the end of this interval.
*/
void setEnd( Id value );
/**
Converts this set into an IMAP compatible sequence.
*/
QByteArray toImapSequence() const;
private:
class Private;
QSharedDataPointer<Private> d;
};
/**
Represents a set of natural numbers (1->\f$\infty\f$) in a as compact as possible form.
Used to address Akonadi items via the IMAP protocol or in the database.
This class is implicitly shared.
*/
class AKONADIPROTOCOLINTERNALS_EXPORT ImapSet
{
public:
/**
* Describes the ids stored in the set.
*/
typedef qint64 Id;
/**
Constructs an empty set.
*/
ImapSet();
/**
Copy constructor.
*/
ImapSet( const ImapSet &other );
/**
Destructor.
*/
~ImapSet();
/**
Assignment operator.
*/
ImapSet& operator=( const ImapSet &other );
/**
Adds the given list of positive integer numbers to the set.
The list is sorted and split into as large as possible intervals.
No interval merging is performed.
@param values List of positive integer numbers in arbitrary order
*/
void add( const QVector<Id> &values );
/**
@overload
@deprecated Use the QVector version instead.
*/
void add( const QList<Id> &values );
/**
Adds the given ImapInterval to this set.
No interval merging is performed.
*/
void add( const ImapInterval &interval );
/**
Returns a IMAP-compatible QByteArray representation of this set.
*/
QByteArray toImapSequenceSet() const;
/**
Returns the intervals this set consists of.
*/
ImapInterval::List intervals() const;
/**
Returns true if this set doesn't contains any values.
*/
bool isEmpty() const;
private:
class Private;
QSharedDataPointer<Private> d;
};
}
AKONADIPROTOCOLINTERNALS_EXPORT QDebug& operator<<( QDebug& d, const Akonadi::ImapInterval &interval );
Q_DECLARE_TYPEINFO( Akonadi::ImapInterval, Q_MOVABLE_TYPE );
Q_DECLARE_TYPEINFO( Akonadi::ImapSet, Q_MOVABLE_TYPE );
Q_DECLARE_METATYPE( Akonadi::ImapInterval )
Q_DECLARE_METATYPE( Akonadi::ImapInterval::List )
Q_DECLARE_METATYPE( Akonadi::ImapSet )
#endif
|