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
|
/**
@file icalset.h
@author eric 28 November 1999
Icalset is the "base class" for representations of a collection of
iCal components. Derived classes (actually delegatees) include:
icalfileset Store components in a single file
icaldirset Store components in multiple files in a directory
icalbdbset Store components in a Berkeley DB File
icalheapset Store components on the heap
icalmysqlset Store components in a mysql database.
**/
/*
(C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
This library is free software; you can redistribute it and/or modify
it under the terms of either:
The LGPL as published by the Free Software Foundation, version
2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
Or:
The Mozilla Public License Version 2.0. You may obtain a copy of
the License at https://www.mozilla.org/MPL/
The Original Code is eric. The Initial Developer of the Original
Code is Eric Busboom
======================================================================*/
#ifndef ICALSET_H
#define ICALSET_H
#include "libical_icalss_export.h"
#include "icalgauge.h"
#include "icalcomponent.h"
#include "icalerror.h"
typedef struct icalset_impl icalset;
typedef enum icalset_kind
{
ICAL_FILE_SET,
ICAL_DIR_SET,
ICAL_BDB_SET
} icalset_kind;
typedef struct icalsetiter
{
icalcompiter iter; /* icalcomponent_kind, pvl_elem iter */
icalgauge *gauge;
icalrecur_iterator *ritr; /*the last iterator */
icalcomponent *last_component; /*the pending recurring component to be processed */
const char *tzid; /* the calendar's timezone id */
} icalsetiter;
struct icalset_impl
{
icalset_kind kind;
size_t size;
char *dsn;
icalset *(*init) (icalset *set, const char *dsn, void *options);
void (*free) (icalset *set);
const char *(*path) (icalset *set);
void (*mark) (icalset *set);
icalerrorenum(*commit) (icalset *set);
icalerrorenum(*add_component) (icalset *set, icalcomponent *comp);
icalerrorenum(*remove_component) (icalset *set, icalcomponent *comp);
int (*count_components) (icalset *set, icalcomponent_kind kind);
icalerrorenum(*select) (icalset *set, icalgauge *gauge);
void (*clear) (icalset *set);
icalcomponent *(*fetch) (icalset *set, icalcomponent_kind kind, const char *uid);
icalcomponent *(*fetch_match) (icalset *set, icalcomponent *comp);
int (*has_uid) (icalset *set, const char *uid);
icalerrorenum(*modify) (icalset *set, icalcomponent *old, icalcomponent *newc);
icalcomponent *(*get_current_component) (icalset *set);
icalcomponent *(*get_first_component) (icalset *set);
icalcomponent *(*get_next_component) (icalset *set);
icalsetiter(*icalset_begin_component) (icalset *set,
icalcomponent_kind kind, icalgauge *gauge,
const char *tzid);
icalcomponent *(*icalsetiter_to_next) (icalset *set, icalsetiter *i);
icalcomponent *(*icalsetiter_to_prior) (icalset *set, icalsetiter *i);
};
/** @brief Registers a new derived class */
LIBICAL_ICALSS_EXPORT int icalset_register_class(icalset *set);
/** @brief Generic icalset constructor
*
* @param kind The type of icalset to create
* @param dsn Data Source Name - usually a pathname or DB handle
* @param options Any implementation specific options
*
* @return A valid icalset reference or NULL if error.
*
* This creates any of the icalset types available.
*/
LIBICAL_ICALSS_EXPORT icalset *icalset_new(icalset_kind kind, const char *dsn, void *options);
LIBICAL_ICALSS_EXPORT icalset *icalset_new_file(const char *path);
LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_reader(const char *path);
LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_writer(const char *path);
LIBICAL_ICALSS_EXPORT icalset *icalset_new_dir(const char *path);
/**
* Frees the memory associated with this icalset
* automatically calls the implementation specific free routine
*/
LIBICAL_ICALSS_EXPORT void icalset_free(icalset *set);
LIBICAL_ICALSS_EXPORT const char *icalset_path(icalset *set);
/** Marks the cluster as changed, so it will be written to disk when it
is freed. **/
LIBICAL_ICALSS_EXPORT void icalset_mark(icalset *set);
/** Writes changes to disk immediately */
LIBICAL_ICALSS_EXPORT icalerrorenum icalset_commit(icalset *set);
LIBICAL_ICALSS_EXPORT icalerrorenum icalset_add_component(icalset *set, icalcomponent *comp);
LIBICAL_ICALSS_EXPORT icalerrorenum icalset_remove_component(icalset *set, icalcomponent *comp);
LIBICAL_ICALSS_EXPORT int icalset_count_components(icalset *set, icalcomponent_kind kind);
/** Restricts the component returned by icalset_first, _next to those
that pass the gauge. */
LIBICAL_ICALSS_EXPORT icalerrorenum icalset_select(icalset *set, icalgauge *gauge);
/** Gets a component by uid */
LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch(icalset *set, const char *uid);
LIBICAL_ICALSS_EXPORT int icalset_has_uid(icalset *set, const char *uid);
LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch_match(icalset *set, icalcomponent *c);
/** Modifies components according to the MODIFY method of CAP. Works on
the currently selected components. */
LIBICAL_ICALSS_EXPORT icalerrorenum icalset_modify(icalset *set,
icalcomponent *oldc, icalcomponent *newc);
/** Iterates through the components. If a gauge has been defined, these
will skip over components that do not pass the gauge */
LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_current_component(icalset *set);
LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_first_component(icalset *set);
LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_next_component(icalset *set);
/** External Iterator with gauge - for thread safety */
LIBICAL_ICALSS_EXPORT extern icalsetiter icalsetiter_null;
LIBICAL_ICALSS_EXPORT icalsetiter icalset_begin_component(icalset *set,
icalcomponent_kind kind,
icalgauge *gauge, const char *tzid);
/** Default _next, _prior, _deref for subclasses that use single cluster */
LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_next(icalsetiter *i);
LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_prior(icalsetiter *i);
LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_deref(icalsetiter *i);
/** for subclasses that use multiple clusters that require specialized cluster traversal */
LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_next(icalset *set, icalsetiter *i);
LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_prior(icalset *set, icalsetiter *i);
#endif /* !ICALSET_H */
|
