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
|
/*
This file is part of the Opie Project
Copyright (C) Holger Freyther <zecke@handhelds.org>
=. Copyright (C) The Opie Team <opie-devel@handhelds.org>
.=l.
.>+-=
_;:, .> :=|. This program is free software; you can
.> <`_, > . <= redistribute it and/or modify it under
:`=1 )Y*s>-.-- : the terms of the GNU Library General Public
.="- .-=="i, .._ License as published by the Free Software
- . .-<_> .<> Foundation; either version 2 of the License,
._= =} : or (at your option) any later version.
.%`+i> _;_.
.i_,=:_. -<s. 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
..}^=.= = ; 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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef OTEMPLATEBASE_H
#define OTEMPLATEBASE_H
/* OPIE */
#include <opie2/opimrecord.h>
#include <opie2/opimcache.h>
#include <opie2/opimoccurrence.h>
#include <opie2/opimbackendoccurrence.h>
/* QT */
#include <qarray.h>
#include <qdatetime.h>
namespace Opie {
class OPimBasePrivate;
/**
* This is the base class for all our Interfaces to the
* PIM Records. It is pointer based and can be used
* generically for all types of Records.
*
*/
struct OPimBase {
//@{
OPimBase();
virtual ~OPimBase();
//@}
//@{
/**
* return the rtti
*/
virtual int rtti() const = 0;
virtual OPimRecord* record()const = 0;
virtual OPimRecord* record(int uid)const = 0;
//@}
//@{
virtual bool add( const OPimRecord& ) = 0;
virtual bool add( const OPimRecord* ) = 0;
virtual bool remove( int uid ) = 0;
virtual bool remove( const OPimRecord& ) = 0;
//@}
//@{
virtual void clear() = 0;
virtual bool load() = 0;
virtual bool save() = 0;
//@}
//@{
virtual QArray<UID> records()const = 0;
//@}
/** Constants for query.
* Use this constants to set the query parameters.
* Note: <i>query_IgnoreCase</i> just make sense with one of the other attributes !
* @see queryByExample()
*/
enum QuerySettings {
/** Use Wildcards */
WildCards = 0x0001,
/** Ignore the Case */
IgnoreCase = 0x0002,
/** Do a Regular Expression match */
RegExp = 0x0004,
/** It needs to exactly match */
ExactMatch = 0x0008,
/** Only one Entry must match */
MatchOne = 0x0010,
/** Find all entries from today until given date */
DateDiff = 0x0020,
/** The year matches */
DateYear = 0x0040,
/** The month matches */
DateMonth = 0x0080,
/** The day matches */
DateDay = 0x0100,
/** The last possible name matches */
LastItem = 0xffff
};
/**
* Common Attributes for the Sort Order
*/
enum SortOrderBase {
/** Sort by a Summary of the records */
SortSummary = 0,
/** Sort by Category */
SortByCategory = 1,
/** Sort by Date */
SortByDate = 2,
/** The First available sort number for the OPimAccessTemplates */
SortCustom = 10,
/** make this enum 16bit large */
LastSortOrderBase = 0xffff
};
/**
* Sort a list of Items with the help of the sorted() function.
* The Item you provide in SortOrder will be used
* for sorting.
*
* @see OPimAccessTemplate<>::sorted()
*/
enum SortFilterBase {
/** Do not filter anything. */
FilterOff = 0,
/** Use given Categories for filter */
FilterCategory = 1,
/** The first available custom filter defined in the specialized frontends */
FilterCustom = 1024,
LastSortFilterBase = 0xffffffff
};
virtual UIDArray matchRegexpSimple( const QRegExp& r )const = 0;
virtual UIDArray queryByExampleSimple( const OPimRecord*, int settings,
const QDateTime& d = QDateTime() )const = 0;
virtual UIDArray sortedSimple( const UIDArray& uid, bool ascending,
int sortOrder, int sortFilter, int cat)const = 0;
virtual UIDArray sortedSimple( const UIDArray& uid, bool ascending,
int sortOrder, int sortFilter, const QArray<UID>& cats )const = 0;
virtual UIDArray sortedSimple( bool ascending, int sortOrder, int sortFilter, int cat)const = 0;
virtual UIDArray sortedSimple( bool ascending, int sortOrder, int sortFilter, const QArray<UID>& cats )const = 0;
virtual OPimOccurrence::List occurrences( const QDate& start, const QDate& end )const = 0;
virtual OPimOccurrence::List occurrences( const QDateTime& dt )const = 0;
//@}
protected:
OPimOccurrence::List convertOccurrenceFromBackend( const OPimBackendOccurrence::List& )const;
private:
OPimBasePrivate* d;
};
/**
* internal template base
* Attention: T needs to implement the copy c'tor!!!
*/
class OTemplateBasePrivate;
template <class T = OPimRecord>
class OTemplateBase : public OPimBase {
public:
/**
* The Direction for ReadAhead/ReadBehind which will
* be used by the backends to Cache Items in
* advance.
* For example if you know that you will access the
* next ten items you can give the backend a hint
* to read ahead or read before.
*/
enum CacheDirection {
Forward=0, /** Go forward when caching (++ to the index) */
Reverse /** Go backward when caching (-- to the index) */
};
//@{
OTemplateBase() {};
virtual ~OTemplateBase() {}
//@}
//@{
virtual T find( int uid )const = 0;
/**
* read ahead find
*/
virtual T find( int uid, const QArray<int>& items,
uint current, CacheDirection dir = Forward )const = 0;
//@}
//@{
/**
* Put element into Cache
*/
virtual void cache( const T& )const = 0;
virtual void setSaneCacheSize( int ) = 0;
OPimRecord* record()const;
OPimRecord* record(int uid )const;
static T* rec();
//@}
private:
OTemplateBasePrivate *d;
};
template <class T>
OPimRecord* OTemplateBase<T>::record()const {
T* t = new T;
return t;
}
template <class T>
OPimRecord* OTemplateBase<T>::record(int uid )const {
T t2 = find(uid );
T* t1 = new T(t2);
return t1;
}
template <class T>
T* OTemplateBase<T>::rec() {
return new T;
}
}
#endif
|
