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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <glib-object.h>
// Initializes the API below, returns false if not available
bool EApiInit();
G_BEGIN_DECLS
// This header defined all the API methods as
// function pointers instead of real functions
// this will all evaporate as it is compiled generating
// no symbol lookups or relocations, but giving code
// clarity.
// We attempt to define a minimum API that we use:
// e-contact.h
#ifdef DECLARE_FN_POINTERS
#define EAPI_EXTERN
#else
#define EAPI_EXTERN extern
#endif
typedef void EContact;
#define E_CONTACT(a) ((EContact *)(a))
#define E_TYPE_CONTACT (e_contact_get_type())
typedef int EContactField;
EAPI_EXTERN const char *(*e_contact_field_name) ( EContactField field_id);
EAPI_EXTERN gpointer (*e_contact_get) (EContact *contact, EContactField field_id);
EAPI_EXTERN gconstpointer (*e_contact_get_const) (EContact *contact, EContactField field_id);
// e-source.h
typedef void ESource;
#define E_SOURCE(a) ((ESource *)(a))
EAPI_EXTERN const char *(*e_source_peek_name) (ESource *source);
EAPI_EXTERN const gchar *(*e_source_get_property) (ESource *source,
const gchar *property);
EAPI_EXTERN GType (*e_contact_get_type) (void);
EAPI_EXTERN EContactField (*e_contact_field_id) (const char *field_name);
// e-source-list.h
typedef void ESourceList;
EAPI_EXTERN GSList *(*e_source_list_peek_groups) (ESourceList *list);
// e-source-group.h
typedef void ESourceGroup;
#define E_SOURCE_GROUP(a) ((ESourceGroup *)(a))
EAPI_EXTERN GSList *(*e_source_group_peek_sources) (ESourceGroup *group);
EAPI_EXTERN const char *(*e_source_group_peek_base_uri) (ESourceGroup *group);
// e-book.h
typedef enum {
E_BOOK_QUERY_IS,
E_BOOK_QUERY_CONTAINS,
E_BOOK_QUERY_BEGINS_WITH,
E_BOOK_QUERY_ENDS_WITH,
} EBookQueryTest;
typedef void EBook;
typedef void EBookQuery;
EAPI_EXTERN EBook *(*e_book_new) (ESource *source,
GError **error);
EAPI_EXTERN gboolean (*e_book_open) (EBook *book,
gboolean only_if_exists,
GError **error);
EAPI_EXTERN const char *(*e_book_get_uri) (EBook *book);
EAPI_EXTERN ESource *(*e_book_get_source)(EBook *book);
EAPI_EXTERN gboolean (*e_book_get_addressbooks) (ESourceList **addressbook_sources,
GError **error);
EAPI_EXTERN gboolean (*e_book_get_contacts) (EBook *book,
EBookQuery *query,
GList **contacts,
GError **error);
EAPI_EXTERN gboolean (*e_book_authenticate_user) (EBook *book,
const char *user,
const char *passwd,
const char *auth_method,
GError **error);
// e-book-query.h
EAPI_EXTERN EBookQuery* (*e_book_query_field_exists) (EContactField field);
EAPI_EXTERN EBookQuery* (*e_book_query_field_test) (EContactField field,
EBookQueryTest test,
const char *value);
EAPI_EXTERN EBookQuery* (*e_book_query_and) (int nqs, EBookQuery **qs, gboolean unref);
EAPI_EXTERN EBookQuery* (*e_book_query_or) (int nqs, EBookQuery **qs, gboolean unref);
EAPI_EXTERN EBookQuery* (*e_book_query_not) (EBookQuery *q, gboolean unref);
EAPI_EXTERN EBookQuery* (*e_book_query_ref) (EBookQuery *q);
EAPI_EXTERN void (*e_book_query_unref) (EBookQuery *q);
EAPI_EXTERN char* (*e_book_query_to_string) (EBookQuery *q);
EAPI_EXTERN EBookQuery* (*e_book_query_from_string) (const char *query_string);
typedef struct {
char *address_format; /* the two letter country code that
determines the format/meaning of the
following fields */
char *po;
char *ext;
char *street;
char *locality;
char *region;
char *code;
char *country;
} EContactAddress;
#define E_SOURCE_EXTENSION_ADDRESS_BOOK "Address Book"
typedef void ESourceRegistry;
typedef void GCancellable;
typedef void ESourceBackend;
typedef void EClient;
typedef EClient EBookClient;
EAPI_EXTERN ESourceRegistry* (*e_source_registry_new_sync) (GCancellable *cancellable, GError **error);
EAPI_EXTERN GList* (*e_source_registry_list_sources) (ESourceRegistry *registry, const gchar *extension_name);
EAPI_EXTERN gboolean (*e_source_has_extension) (ESource *source, const gchar *extension_name);
EAPI_EXTERN gpointer (*e_source_get_extension) (ESource *source, const gchar *extension_name);
EAPI_EXTERN const gchar* (*e_source_backend_get_backend_name) (ESourceBackend *extension);
EAPI_EXTERN const gchar* (*e_source_get_display_name) (ESource *source);
EAPI_EXTERN const gchar* (*eds_check_version) (guint required_major, guint required_minor, guint required_micro);
EAPI_EXTERN const gchar* (*e_source_get_uid) (ESource *source);
EAPI_EXTERN ESource* (*e_source_registry_ref_source) (ESourceRegistry *registry, const gchar *uid);
EAPI_EXTERN EBookClient* (*e_book_client_new) (ESource *source, GError **error);
EAPI_EXTERN EBookClient* (*e_book_client_connect_direct_sync) (ESourceRegistry *registry, ESource *source, guint32 wait_for_connected_seconds, GCancellable *cancellable, GError **error);
EAPI_EXTERN gboolean (*e_client_open_sync) (EClient *client, gboolean only_if_exists, GCancellable *cancellable, GError **error);
EAPI_EXTERN ESource* (*e_client_get_source) (EClient *client);
EAPI_EXTERN gboolean (*e_book_client_get_contacts_sync) (EBookClient *client, const gchar *sexp, GSList **contacts, GCancellable *cancellable, GError **error);
EAPI_EXTERN void (*e_client_util_free_object_slist) (GSList *objects);
ESourceRegistry *get_e_source_registry();
bool isSourceBackend(ESource *pSource, const char *backendname);
G_END_DECLS
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
