builtin-gconf.h 5.63 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/**
 * @file builtin-gconf.h
 * Mode Control Entity - Build-in GConf compatible settings
 * <p>
 * Copyright (C) 2012-2019 Jolla Ltd.
 * <p>
 * @author Simo Piiroinen <simo.piiroinen@jollamobile.com>
 *
 * mce is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * mce 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 mce.  If not, see <http://www.gnu.org/licenses/>.
 */
21 22 23 24

#ifndef BUILTIN_GCONF_H_
# define BUILTIN_GCONF_H_

25
#include <stdbool.h>
26 27
#include <glib.h>

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
# ifdef __cplusplus
extern "C" {
# elif 0
} /* fool JED indentation ... */
# endif

/* ========================================================================= *
 *
 * TYPES
 *
 * ========================================================================= */

typedef enum
{
  GCONF_ERROR_SUCCESS              =  0,
  GCONF_ERROR_FAILED               =  1,

  GCONF_ERROR_NO_SERVER            =  2,
  GCONF_ERROR_NO_PERMISSION        =  3,
  GCONF_ERROR_BAD_ADDRESS          =  4,
  GCONF_ERROR_BAD_KEY              =  5,

  GCONF_ERROR_PARSE_ERROR          =  6,
  GCONF_ERROR_CORRUPT              =  7,
  GCONF_ERROR_TYPE_MISMATCH        =  8,
  GCONF_ERROR_IS_DIR               =  9,
  GCONF_ERROR_IS_KEY               = 10,
  GCONF_ERROR_OVERRIDDEN           = 11,
  GCONF_ERROR_OAF_ERROR            = 12,
  GCONF_ERROR_LOCAL_ENGINE         = 13,
  GCONF_ERROR_LOCK_FAILED          = 14,
  GCONF_ERROR_NO_WRITABLE_DATABASE = 15,
  GCONF_ERROR_IN_SHUTDOWN          = 16,
} GConfError;

typedef enum
{
  GCONF_VALUE_INVALID,
  GCONF_VALUE_STRING,
  GCONF_VALUE_INT,
  GCONF_VALUE_FLOAT,
  GCONF_VALUE_BOOL,
  GCONF_VALUE_SCHEMA,
  GCONF_VALUE_LIST,
  GCONF_VALUE_PAIR

} GConfValueType;

typedef struct GConfValue
{
  // public

  GConfValueType type;

  // private

  int refcount;

  union {
    gboolean b;
    gint     i;
    char    *s;
    double   f;
  } data;

  GConfValueType  list_type;
  GSList         *list_head;

} GConfValue;

typedef struct GConfEntry
{
  // public

  char *key;
  GConfValue *value;

  // private

  char *def;

109 110 111
  bool notify_entered; // already withing gconf_client_notify_change()
  bool notify_changed; // another round of notifications needed within gconf_client_notify_change()

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
} GConfEntry;

typedef struct GConfClient
{
  // public

  // (nothing)

  // private

  GSList  *entries;

  GSList  *notify_list;

} GConfClient;

typedef enum
{
  GCONF_CLIENT_PRELOAD_NONE,
  GCONF_CLIENT_PRELOAD_ONELEVEL,
  GCONF_CLIENT_PRELOAD_RECURSIVE
} GConfClientPreloadType;

typedef void (*GConfClientNotifyFunc)(GConfClient *client,
                                      guint cnxn_id,
                                      GConfEntry *entry,
                                      gpointer user_data);

typedef struct GConfClientNotify
{
  guint                 id;
  gchar                *namespace_section;
  GConfClientNotifyFunc func;
  gpointer              user_data;
  GFreeFunc             destroy_notify;

} GConfClientNotify;

/* ------------------------------------------------------------------------- *
 *
 * FUNCTIONS
 *
 * ------------------------------------------------------------------------- */

gchar *gconf_concat_dir_and_key(const gchar *dir, const gchar *key);
GConfValue *gconf_value_copy(const GConfValue *src);
GConfValue *gconf_value_new(GConfValueType type);
void gconf_value_free(GConfValue *self);
gboolean gconf_value_get_bool(const GConfValue *self);
161
bool gconf_value_set_bool(GConfValue *self, gboolean val);
162
int gconf_value_get_int(const GConfValue *self);
163
bool gconf_value_set_int(GConfValue *self, gint val);
164
double gconf_value_get_float(const GConfValue *self);
165
bool gconf_value_set_float(GConfValue *self, double val);
166
const char *gconf_value_get_string(const GConfValue *self);
167
bool gconf_value_set_string(GConfValue *self, const char *val);
168 169 170
GConfValueType gconf_value_get_list_type(const GConfValue *self);
void gconf_value_set_list_type(GConfValue *self, GConfValueType list_type);
GSList *gconf_value_get_list(const GConfValue *self);
171
bool gconf_value_set_list(GConfValue *self, GSList *list);
172 173 174
const char *gconf_entry_get_key(const GConfEntry *entry);
GConfValue *gconf_entry_get_value(const GConfEntry *entry);
GConfClient *gconf_client_get_default(void);
175
int gconf_client_reset_defaults(GConfClient *self, const char *keyish);
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
void gconf_client_add_dir(GConfClient *client, const gchar *dir, GConfClientPreloadType preload, GError **err);
GConfValue *gconf_client_get(GConfClient *self, const gchar *key, GError **err);
gboolean gconf_client_set_bool(GConfClient *client, const gchar *key, gboolean val, GError **err);
gboolean gconf_client_set_int(GConfClient *client, const gchar *key, gint val, GError **err);
gboolean gconf_client_set_float(GConfClient *client, const gchar *key, double val, GError **err);
gboolean gconf_client_set_string(GConfClient *client, const gchar *key, const gchar *val, GError **err);
gboolean gconf_client_set_list(GConfClient *client, const gchar *key, GConfValueType list_type, GSList *list, GError **err);
void gconf_client_suggest_sync(GConfClient *client, GError **err);
guint gconf_client_notify_add(GConfClient *client, const gchar *namespace_section, GConfClientNotifyFunc func, gpointer user_data, GFreeFunc destroy_notify, GError **err);
void gconf_client_notify_remove(GConfClient *client, guint cnxn);

# ifdef __cplusplus
};
# endif

#endif /* BUILTIN_GCONF_H_ */