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
|
/* GConf
* Copyright (C) 1999, 2000 Red Hat Inc.
*
* 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; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef GCONF_GCONFBACKEND_H
#define GCONF_GCONFBACKEND_H
#include "gconf/gconf-internals.h"
#include <gmodule.h>
#include "gconf/gconf-sources.h"
/*
* This vtable is more complicated than strictly necessary, hoping
* that backends can be smart and optimize some calls
*/
typedef struct _GConfBackendVTable GConfBackendVTable;
struct _GConfBackendVTable {
/* Set to sizeof (GConfBackendVTable) - used for future proofing */
gsize vtable_size;
void (* shutdown) (GError** err);
GConfSource* (* resolve_address) (const gchar* address,
GError** err);
/* Thread locks. If the backend is thread-safe, then these
* can be NULL. If per-source locks are needed, then these
* calls should lock a mutex stored in the GConfSource.
* If a per-backend lock is needed, then the calls can ignore
* their source argument and lock the whole backend.
*/
void (* lock) (GConfSource* source,
GError** err);
void (* unlock) (GConfSource* source,
GError** err);
/* Report whether a given key (and its subkeys) can be read/written.
* Sources may not permit reading/writing from/to /foo but forbid
* writing to /foo/bar; if a key can be read or written then its
* subkeys may also be read/written.
*
* This field allows backends to be configured so that they only
* store certain kinds of data in certain sections of the GConf
* namespace.
*
* If these functions return an error, they MUST return FALSE as
* well.
*/
gboolean (* readable) (GConfSource* source,
const gchar* key,
GError** err);
gboolean (* writable) (GConfSource* source,
const gchar* key,
GError** err);
/* schema_name filled if NULL or GCONF_VALUE_IGNORE_SUBSEQUENT returned.
if schema_name is NULL, it isn't filled */
GConfValue* (* query_value) (GConfSource* source,
const gchar* key,
const gchar** locales,
gchar** schema_name,
GError** err);
GConfMetaInfo* (* query_metainfo) (GConfSource* source,
const gchar* key,
GError** err);
void (* set_value) (GConfSource* source,
const gchar* key,
const GConfValue* value,
GError** err);
/* Returns list of GConfEntry with key set to a relative
* pathname. In the public client-side API the key
* is always absolute though.
*/
GSList* (* all_entries) (GConfSource* source,
const gchar* dir,
const gchar** locales,
GError** err);
/* Returns list of allocated strings, relative names */
GSList* (* all_subdirs) (GConfSource* source,
const gchar* dir,
GError** err);
void (* unset_value) (GConfSource* source,
const gchar* key,
const gchar* locale,
GError** err);
gboolean (* dir_exists) (GConfSource* source,
const gchar* dir,
GError** err);
void (* remove_dir) (GConfSource* source,
const gchar* dir,
GError** err);
void (* set_schema) (GConfSource* source,
const gchar* key,
const gchar* schema_key,
GError** err);
gboolean (* sync_all) (GConfSource* source,
GError** err);
void (* destroy_source) (GConfSource* source);
/* This is basically used by the test suite */
void (* clear_cache) (GConfSource* source);
/* was used by gconf-sanity-check */
void (* blow_away_locks) (const char *address);
void (* set_notify_func) (GConfSource *source,
GConfSourceNotifyFunc notify_func,
gpointer user_data);
void (* add_listener) (GConfSource *source,
guint id,
const gchar *namespace_section);
void (* remove_listener) (GConfSource *source,
guint id);
};
struct _GConfBackend {
const gchar* name;
guint refcount;
GConfBackendVTable vtable;
GModule* module;
};
/* Address utility stuff */
/* Get the backend name */
gchar* gconf_address_backend(const gchar* address);
/* Get the resource name understood only by the backend */
gchar* gconf_address_resource(const gchar* address);
/* Get the backend flags */
gchar** gconf_address_flags(const gchar* address);
gchar* gconf_backend_file(const gchar* address);
/* Obtain the GConfBackend for this address, based on the first part of the
* address. The refcount is always incremented, and you must unref() later.
* The same backend may be returned by multiple calls to this routine,
* but you can assume they are different if you do the refcounting
* right. Returns NULL if it fails.
*/
GConfBackend* gconf_get_backend(const gchar* address, GError** err);
void gconf_backend_ref(GConfBackend* backend);
void gconf_backend_unref(GConfBackend* backend);
GConfSource* gconf_backend_resolve_address (GConfBackend* backend,
const gchar* address,
GError** err);
void gconf_blow_away_locks (const gchar* address);
#endif
|
