/usr/include/evolution-data-server/libebackend/e-cache.h is in libebackend1.2-dev 3.28.1-1ubuntu1.
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 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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* Copyright (C) 2017 Red Hat, Inc. (www.redhat.com)
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.
*
* 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 Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#if !defined (__LIBEBACKEND_H_INSIDE__) && !defined (LIBEBACKEND_COMPILATION)
#error "Only <libebackend/libebackend.h> should be included directly."
#endif
#ifndef E_CACHE_H
#define E_CACHE_H
#include <glib-object.h>
#include <gio/gio.h>
#include <libebackend/e-backend-enums.h>
/* Standard GObject macros */
#define E_TYPE_CACHE \
(e_cache_get_type ())
#define E_CACHE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_CACHE, ECache))
#define E_CACHE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_CACHE, ECacheClass))
#define E_IS_CACHE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_CACHE))
#define E_IS_CACHE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_CACHE))
#define E_CACHE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_CACHE, ECacheClass))
G_BEGIN_DECLS
#define E_CACHE_TABLE_OBJECTS "ECacheObjects"
#define E_CACHE_TABLE_KEYS "ECacheKeys"
#define E_CACHE_COLUMN_UID "ECacheUID"
#define E_CACHE_COLUMN_REVISION "ECacheREV"
#define E_CACHE_COLUMN_OBJECT "ECacheOBJ"
#define E_CACHE_COLUMN_STATE "ECacheState"
/**
* E_CACHE_ERROR:
*
* Error domain for #ECache operations.
*
* Since: 3.26
**/
#define E_CACHE_ERROR (e_cache_error_quark ())
GQuark e_cache_error_quark (void);
/**
* ECacheError:
* @E_CACHE_ERROR_ENGINE: An error was reported from the SQLite engine
* @E_CACHE_ERROR_CONSTRAINT: The error occurred due to an explicit constraint, like
* when attempting to add two objects with the same UID.
* @E_CACHE_ERROR_NOT_FOUND: An object was not found by UID (this is
* different from a query that returns no results, which is not an error).
* @E_CACHE_ERROR_INVALID_QUERY: A query was invalid.
* @E_CACHE_ERROR_UNSUPPORTED_FIELD: A field requested for inclusion in summary is not supported.
* @E_CACHE_ERROR_UNSUPPORTED_QUERY: A query was not supported.
* @E_CACHE_ERROR_END_OF_LIST: An attempt was made to fetch results past the end of a the list.
* @E_CACHE_ERROR_LOAD: An error occured while loading or creating the database.
*
* Defines the types of possible errors reported by the #ECache
*
* Since: 3.26
*/
typedef enum {
E_CACHE_ERROR_ENGINE,
E_CACHE_ERROR_CONSTRAINT,
E_CACHE_ERROR_NOT_FOUND,
E_CACHE_ERROR_INVALID_QUERY,
E_CACHE_ERROR_UNSUPPORTED_FIELD,
E_CACHE_ERROR_UNSUPPORTED_QUERY,
E_CACHE_ERROR_END_OF_LIST,
E_CACHE_ERROR_LOAD
} ECacheError;
typedef struct _ECacheColumnValues ECacheColumnValues;
#define E_TYPE_CACHE_COLUMN_VALUES (e_cache_column_values_get_type ())
GType e_cache_column_values_get_type (void) G_GNUC_CONST;
ECacheColumnValues *
e_cache_column_values_new (void);
ECacheColumnValues *
e_cache_column_values_copy (ECacheColumnValues *other_columns);
void e_cache_column_values_free (ECacheColumnValues *other_columns);
void e_cache_column_values_put (ECacheColumnValues *other_columns,
const gchar *name,
const gchar *value);
void e_cache_column_values_take_value(ECacheColumnValues *other_columns,
const gchar *name,
gchar *value);
void e_cache_column_values_take (ECacheColumnValues *other_columns,
gchar *name,
gchar *value);
gboolean e_cache_column_values_contains (ECacheColumnValues *other_columns,
const gchar *name);
gboolean e_cache_column_values_remove (ECacheColumnValues *other_columns,
const gchar *name);
void e_cache_column_values_remove_all(ECacheColumnValues *other_columns);
const gchar * e_cache_column_values_lookup (ECacheColumnValues *other_columns,
const gchar *name);
guint e_cache_column_values_get_size (ECacheColumnValues *other_columns);
void e_cache_column_values_init_iter (ECacheColumnValues *other_columns,
GHashTableIter *iter);
/**
* ECacheOfflineChange:
* @uid: UID of the object
* @revision: stored revision of the object
* @object: the object itself
* @state: an #EOfflineState of the object
*
* Holds the information about offline change for one object.
*
* Since: 3.26
**/
typedef struct {
gchar *uid;
gchar *revision;
gchar *object;
EOfflineState state;
} ECacheOfflineChange;
#define E_TYPE_CACHE_OFFLINE_CHANGE (e_cache_offline_change_get_type ())
GType e_cache_offline_change_get_type (void) G_GNUC_CONST;
ECacheOfflineChange *
e_cache_offline_change_new (const gchar *uid,
const gchar *revision,
const gchar *object,
EOfflineState state);
ECacheOfflineChange *
e_cache_offline_change_copy (const ECacheOfflineChange *change);
void e_cache_offline_change_free (/* ECacheOfflineChange */ gpointer change);
typedef struct {
gchar *name;
gchar *type;
gchar *index_name;
} ECacheColumnInfo;
#define E_TYPE_CACHE_COLUMN_INFO (e_cache_column_info_get_type ())
GType e_cache_column_info_get_type (void) G_GNUC_CONST;
ECacheColumnInfo *
e_cache_column_info_new (const gchar *name,
const gchar *type,
const gchar *index_name);
ECacheColumnInfo *
e_cache_column_info_copy (const ECacheColumnInfo *info);
void e_cache_column_info_free (/* ECacheColumnInfo */ gpointer info);
/**
* ECacheLockType:
* @E_CACHE_LOCK_READ: Obtain a lock for reading.
* @E_CACHE_LOCK_WRITE: Obtain a lock for writing. This also starts a transaction.
*
* Indicates the type of lock requested in e_cache_lock().
*
* Since: 3.26
**/
typedef enum {
E_CACHE_LOCK_READ,
E_CACHE_LOCK_WRITE
} ECacheLockType;
/**
* ECacheUnlockAction:
* @E_CACHE_UNLOCK_NONE: Just unlock, this is appropriate for locks which were obtained with %E_CACHE_LOCK_READ.
* @E_CACHE_UNLOCK_COMMIT: Commit any modifications which were made while the lock was held.
* @E_CACHE_UNLOCK_ROLLBACK: Rollback any modifications which were made while the lock was held.
*
* Indicates what type of action to take while unlocking the cache with e_cache_unlock().
*
* Since: 3.26
**/
typedef enum {
E_CACHE_UNLOCK_NONE,
E_CACHE_UNLOCK_COMMIT,
E_CACHE_UNLOCK_ROLLBACK
} ECacheUnlockAction;
/**
* ECacheDeletedFlag:
* @E_CACHE_EXCLUDE_DELETED: Do not include locally deleted objects
* @E_CACHE_INCLUDE_DELETED: Include locally deleted objects
*
* Declares whether to exclude or include locally deleted objects.
*
* Since: 3.26
**/
typedef enum {
E_CACHE_EXCLUDE_DELETED = 0,
E_CACHE_INCLUDE_DELETED
} ECacheDeletedFlag;
/**
* ECacheOfflineFlag:
* @E_CACHE_OFFLINE_UNKNOWN: Do not know current online/offline state
* @E_CACHE_IS_ONLINE: The operation is done in online
* @E_CACHE_IS_OFFLINE: The operation is done in offline
*
* Declares whether the operation is done in online or offline.
* This influences the offline state of the related objects.
*
* Since: 3.26
**/
typedef enum {
E_CACHE_OFFLINE_UNKNOWN = -1,
E_CACHE_IS_ONLINE = 0,
E_CACHE_IS_OFFLINE
} ECacheOfflineFlag;
typedef struct _ECache ECache;
typedef struct _ECacheClass ECacheClass;
typedef struct _ECachePrivate ECachePrivate;
/**
* ECacheForeachFunc:
* @cache: an #ECache
* @uid: a unique object identifier
* @revision: the object revision
* @object: the object itself
* @offline_state: objects offline state, one of #EOfflineState
* @ncols: count of columns, items in column_names and column_values
* @column_names: column names
* @column_values: column values
* @user_data: user data, as used in e_cache_foreach()
*
* A callback called for each object row when using e_cache_foreach() function.
*
* Returns: %TRUE to continue, %FALSE to stop walk through.
*
* Since: 3.26
**/
typedef gboolean (* ECacheForeachFunc) (ECache *cache,
const gchar *uid,
const gchar *revision,
const gchar *object,
EOfflineState offline_state,
gint ncols,
const gchar *column_names[],
const gchar *column_values[],
gpointer user_data);
/**
* ECacheUpdateFunc:
* @cache: an #ECache
* @uid: a unique object identifier
* @revision: the object revision
* @object: the object itself
* @offline_state: objects offline state, one of #EOfflineState
* @ncols: count of columns, items in column_names and column_values
* @column_names: column names
* @column_values: column values
* @out_revision: (out): the new object revision to set; keep it untouched to not change
* @out_object: (out): the new object to set; keep it untouched to not change
* @out_offline_state: (out): the offline state to set; the default is the same as @offline_state
* @out_other_columns: (out) (transfer full): an #ECacheColumnValues with other columns to set; keep it untouched to not change any
* @user_data: user data, as used in e_cache_foreach_update()
*
* A callback called for each object row when using e_cache_foreach_update() function.
* When all out parameters are left untouched, then the row is not changed.
*
* Returns: %TRUE to continue, %FALSE to stop walk through.
*
* Since: 3.26
**/
typedef gboolean (* ECacheUpdateFunc) (ECache *cache,
const gchar *uid,
const gchar *revision,
const gchar *object,
EOfflineState offline_state,
gint ncols,
const gchar *column_names[],
const gchar *column_values[],
gchar **out_revision,
gchar **out_object,
EOfflineState *out_offline_state,
ECacheColumnValues **out_other_columns,
gpointer user_data);
/**
* ECacheSelectFunc:
* @cache: an #ECache
* @ncols: count of columns, items in column_names and column_values
* @column_names: column names
* @column_values: column values
* @user_data: user data, as used in e_cache_sqlite_select()
*
* A callback called for each row of a SELECT statement executed
* with e_cache_sqlite_select() function.
*
* Returns: %TRUE to continue, %FALSE to stop walk through.
*
* Since: 3.26
**/
typedef gboolean (* ECacheSelectFunc) (ECache *cache,
gint ncols,
const gchar *column_names[],
const gchar *column_values[],
gpointer user_data);
/**
* ECache:
*
* Contains only private data that should be read and manipulated using the
* functions below.
*
* Since: 3.26
**/
struct _ECache {
/*< private >*/
GObject parent;
ECachePrivate *priv;
};
struct _ECacheClass {
GObjectClass parent_class;
/* Virtual methods */
gboolean (* put_locked) (ECache *cache,
const gchar *uid,
const gchar *revision,
const gchar *object,
ECacheColumnValues *other_columns,
EOfflineState offline_state,
gboolean is_replace,
GCancellable *cancellable,
GError **error);
gboolean (* remove_locked) (ECache *cache,
const gchar *uid,
GCancellable *cancellable,
GError **error);
gboolean (* remove_all_locked) (ECache *cache,
const GSList *uids, /* gchar * */
GCancellable *cancellable,
GError **error);
gboolean (* clear_offline_changes_locked)
(ECache *cache,
GCancellable *cancellable,
GError **error);
void (* erase) (ECache *cache);
/* Signals */
gboolean (* before_put) (ECache *cache,
const gchar *uid,
const gchar *revision,
const gchar *object,
ECacheColumnValues *other_columns,
gboolean is_replace,
GCancellable *cancellable,
GError **error);
gboolean (* before_remove) (ECache *cache,
const gchar *uid,
GCancellable *cancellable,
GError **error);
void (* revision_changed) (ECache *cache);
/* Padding for future expansion */
gpointer reserved[10];
};
GType e_cache_get_type (void) G_GNUC_CONST;
gboolean e_cache_initialize_sync (ECache *cache,
const gchar *filename,
const GSList *other_columns, /* ECacheColumnInfo * */
GCancellable *cancellable,
GError **error);
const gchar * e_cache_get_filename (ECache *cache);
gint e_cache_get_version (ECache *cache);
void e_cache_set_version (ECache *cache,
gint version);
gchar * e_cache_dup_revision (ECache *cache);
void e_cache_set_revision (ECache *cache,
const gchar *revision);
void e_cache_change_revision (ECache *cache);
void e_cache_freeze_revision_change (ECache *cache);
void e_cache_thaw_revision_change (ECache *cache);
gboolean e_cache_is_revision_change_frozen
(ECache *cache);
void e_cache_erase (ECache *cache);
gboolean e_cache_contains (ECache *cache,
const gchar *uid,
ECacheDeletedFlag deleted_flag);
gchar * e_cache_get (ECache *cache,
const gchar *uid,
gchar **out_revision,
ECacheColumnValues **out_other_columns,
GCancellable *cancellable,
GError **error);
gboolean e_cache_put (ECache *cache,
const gchar *uid,
const gchar *revision,
const gchar *object,
ECacheColumnValues *other_columns,
ECacheOfflineFlag offline_flag,
GCancellable *cancellable,
GError **error);
gboolean e_cache_remove (ECache *cache,
const gchar *uid,
ECacheOfflineFlag offline_flag,
GCancellable *cancellable,
GError **error);
gboolean e_cache_remove_all (ECache *cache,
GCancellable *cancellable,
GError **error);
guint e_cache_get_count (ECache *cache,
ECacheDeletedFlag deleted_flag,
GCancellable *cancellable,
GError **error);
gboolean e_cache_get_uids (ECache *cache,
ECacheDeletedFlag deleted_flag,
GSList **out_uids, /* gchar * */
GSList **out_revisions, /* gchar * */
GCancellable *cancellable,
GError **error);
gboolean e_cache_get_objects (ECache *cache,
ECacheDeletedFlag deleted_flag,
GSList **out_objects, /* gchar * */
GSList **out_revisions, /* gchar * */
GCancellable *cancellable,
GError **error);
gboolean e_cache_foreach (ECache *cache,
ECacheDeletedFlag deleted_flag,
const gchar *where_clause,
ECacheForeachFunc func,
gpointer user_data,
GCancellable *cancellable,
GError **error);
gboolean e_cache_foreach_update (ECache *cache,
ECacheDeletedFlag deleted_flag,
const gchar *where_clause,
ECacheUpdateFunc func,
gpointer user_data,
GCancellable *cancellable,
GError **error);
/* Offline support */
EOfflineState e_cache_get_offline_state (ECache *cache,
const gchar *uid,
GCancellable *cancellable,
GError **error);
gboolean e_cache_set_offline_state (ECache *cache,
const gchar *uid,
EOfflineState state,
GCancellable *cancellable,
GError **error);
GSList * e_cache_get_offline_changes (ECache *cache,
GCancellable *cancellable,
GError **error);
gboolean e_cache_clear_offline_changes (ECache *cache,
GCancellable *cancellable,
GError **error);
/* Custom keys */
gboolean e_cache_set_key (ECache *cache,
const gchar *key,
const gchar *value,
GError **error);
gchar * e_cache_dup_key (ECache *cache,
const gchar *key,
GError **error);
gboolean e_cache_set_key_int (ECache *cache,
const gchar *key,
gint value,
GError **error);
gint e_cache_get_key_int (ECache *cache,
const gchar *key,
GError **error);
/* Locking */
void e_cache_lock (ECache *cache,
ECacheLockType lock_type);
void e_cache_unlock (ECache *cache,
ECacheUnlockAction action);
/* Low-level SQLite functions */
gpointer e_cache_get_sqlitedb (ECache *cache);
gboolean e_cache_sqlite_exec (ECache *cache,
const gchar *sql_stmt,
GCancellable *cancellable,
GError **error);
gboolean e_cache_sqlite_select (ECache *cache,
const gchar *sql_stmt,
ECacheSelectFunc func,
gpointer user_data,
GCancellable *cancellable,
GError **error);
gboolean e_cache_sqlite_maybe_vacuum (ECache *cache,
GCancellable *cancellable,
GError **error);
void e_cache_sqlite_stmt_append_printf
(GString *stmt,
const gchar *format,
...);
gchar * e_cache_sqlite_stmt_printf (const gchar *format,
...);
void e_cache_sqlite_stmt_free (gchar *stmt);
G_END_DECLS
#endif /* E_CACHE_H */
|