glib/gkeyfile.h

   1 /* gkeyfile.h - desktop entry file parser
   2  *
   3  *  Copyright 2004 Red Hat, Inc.
   4  *
   5  *  Ray Strode <halfline@hawaii.rr.com>
   6  *
   7  * GLib is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU Lesser General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * GLib is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with GLib; see the file COPYING.LIB.  If not,
  19  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  *   Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef __G_KEY_FILE_H__
  24 #define __G_KEY_FILE_H__
  25
  26 #include <glib/gerror.h>
  27
  28 G_BEGIN_DECLS
  29
  30 typedef enum
  31 {
  32   G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
  33   G_KEY_FILE_ERROR_PARSE,
  34   G_KEY_FILE_ERROR_NOT_FOUND,
  35   G_KEY_FILE_ERROR_KEY_NOT_FOUND,
  36   G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
  37   G_KEY_FILE_ERROR_INVALID_VALUE
  38 } GKeyFileError;
  39
  40 #define G_KEY_FILE_ERROR g_key_file_error_quark()
  41
  42 GQuark g_key_file_error_quark (void);
  43
  44 typedef struct _GKeyFile GKeyFile;
  45
  46 typedef enum
  47 {
  48   G_KEY_FILE_NONE              = 0,
  49   G_KEY_FILE_KEEP_COMMENTS     = 1 << 0,
  50   G_KEY_FILE_KEEP_TRANSLATIONS = 1 << 1
  51 } GKeyFileFlags;
  52
  53 GKeyFile *g_key_file_new                    (void);
  54 void      g_key_file_free                   (GKeyFile             *key_file);
  55 void      g_key_file_set_list_separator     (GKeyFile             *key_file,
  56                                              gchar                 separator);
  57 gboolean  g_key_file_load_from_file         (GKeyFile             *key_file,
  58                                              const gchar          *file,
  59                                              GKeyFileFlags         flags,
  60                                              GError              **error);
  61 gboolean  g_key_file_load_from_data         (GKeyFile             *key_file,
  62                                              const gchar          *data,
  63                                              gsize                 length,
  64                                              GKeyFileFlags         flags,
  65                                              GError              **error);
  66 gboolean g_key_file_load_from_data_dirs    (GKeyFile             *key_file,
  67                                              const gchar          *file,
  68                                              gchar               **full_path,
  69                                              GKeyFileFlags         flags,
  70                                              GError              **error);
  71 gchar    *g_key_file_to_data                (GKeyFile             *key_file,
  72                                              gsize                *length,
  73                                              GError              **error) G_GNUC_MALLOC;
  74 gchar    *g_key_file_get_start_group        (GKeyFile             *key_file) G_GNUC_MALLOC;
  75 gchar   **g_key_file_get_groups             (GKeyFile             *key_file,
  76                                              gsize                *length) G_GNUC_MALLOC;
  77 gchar   **g_key_file_get_keys               (GKeyFile             *key_file,
  78                                              const gchar          *group_name,
  79                                              gsize                *length,
  80                                              GError              **error) G_GNUC_MALLOC;
  81 gboolean  g_key_file_has_group              (GKeyFile             *key_file,
  82                                              const gchar          *group_name);
  83 gboolean  g_key_file_has_key                (GKeyFile             *key_file,
  84                                              const gchar          *group_name,
  85                                              const gchar          *key,
  86                                              GError              **error);
  87 gchar    *g_key_file_get_value              (GKeyFile             *key_file,
  88                                              const gchar          *group_name,
  89                                              const gchar          *key,
  90                                              GError              **error) G_GNUC_MALLOC;
  91 void      g_key_file_set_value              (GKeyFile             *key_file,
  92                                              const gchar          *group_name,
  93                                              const gchar          *key,
  94                                              const gchar          *value);
  95 gchar    *g_key_file_get_string             (GKeyFile             *key_file,
  96                                              const gchar          *group_name,
  97                                              const gchar          *key,
  98                                              GError              **error) G_GNUC_MALLOC;
  99 void      g_key_file_set_string             (GKeyFile             *key_file,
 100                                              const gchar          *group_name,
 101                                              const gchar          *key,
 102                                              const gchar          *string);
 103 gchar    *g_key_file_get_locale_string      (GKeyFile             *key_file,
 104                                              const gchar          *group_name,
 105                                              const gchar          *key,
 106                                              const gchar          *locale,
 107                                              GError              **error) G_GNUC_MALLOC;
 108 void      g_key_file_set_locale_string      (GKeyFile             *key_file,
 109                                              const gchar          *group_name,
 110                                              const gchar          *key,
 111                                              const gchar          *locale,
 112                                              const gchar          *string);
 113 gboolean  g_key_file_get_boolean            (GKeyFile             *key_file,
 114                                              const gchar          *group_name,
 115                                              const gchar          *key,
 116                                              GError              **error);
 117 void      g_key_file_set_boolean            (GKeyFile             *key_file,
 118                                              const gchar          *group_name,
 119                                              const gchar          *key,
 120                                              gboolean              value);
 121 gint      g_key_file_get_integer            (GKeyFile             *key_file,
 122                                              const gchar          *group_name,
 123                                              const gchar          *key,
 124                                              GError              **error);
 125 void      g_key_file_set_integer            (GKeyFile             *key_file,
 126                                              const gchar          *group_name,
 127                                              const gchar          *key,
 128                                              gint                  value);
 129 gdouble   g_key_file_get_double             (GKeyFile             *key_file,
 130                                              const gchar          *group_name,
 131                                              const gchar          *key,
 132                                              GError              **error);
 133 void      g_key_file_set_double             (GKeyFile             *key_file,
 134                                              const gchar          *group_name,
 135                                              const gchar          *key,
 136                                              gdouble               value);
 137 gchar   **g_key_file_get_string_list        (GKeyFile             *key_file,
 138                                              const gchar          *group_name,
 139                                              const gchar          *key,
 140                                              gsize                *length,
 141                                              GError              **error) G_GNUC_MALLOC;
 142 void      g_key_file_set_string_list        (GKeyFile             *key_file,
 143                                              const gchar          *group_name,
 144                                              const gchar          *key,
 145                                              const gchar * const   list[],
 146                                              gsize                 length);
 147 gchar   **g_key_file_get_locale_string_list (GKeyFile             *key_file,
 148                                              const gchar          *group_name,
 149                                              const gchar          *key,
 150                                              const gchar          *locale,
 151                                              gsize                *length,
 152                                              GError              **error) G_GNUC_MALLOC;
 153 void      g_key_file_set_locale_string_list (GKeyFile             *key_file,
 154                                              const gchar          *group_name,
 155                                              const gchar          *key,
 156                                              const gchar          *locale,
 157                                              const gchar * const   list[],
 158                                              gsize                 length);
 159 gboolean *g_key_file_get_boolean_list       (GKeyFile             *key_file,
 160                                              const gchar          *group_name,
 161                                              const gchar          *key,
 162                                              gsize                *length,
 163                                              GError              **error) G_GNUC_MALLOC;
 164 void      g_key_file_set_boolean_list       (GKeyFile             *key_file,
 165                                              const gchar          *group_name,
 166                                              const gchar          *key,
 167                                              gboolean              list[],
 168                                              gsize                 length);
 169 gint     *g_key_file_get_integer_list       (GKeyFile             *key_file,
 170                                              const gchar          *group_name,
 171                                              const gchar          *key,
 172                                              gsize                *length,
 173                                              GError              **error) G_GNUC_MALLOC;
 174 void      g_key_file_set_double_list        (GKeyFile             *key_file,
 175                                              const gchar          *group_name,
 176                                              const gchar          *key,
 177                                              gdouble               list[],
 178                                              gsize                 length);
 179 gdouble  *g_key_file_get_double_list        (GKeyFile             *key_file,
 180                                              const gchar          *group_name,
 181                                              const gchar          *key,
 182                                              gsize                *length,
 183                                              GError              **error) G_GNUC_MALLOC;
 184 void      g_key_file_set_integer_list       (GKeyFile             *key_file,
 185                                              const gchar          *group_name,
 186                                              const gchar          *key,
 187                                              gint                  list[],
 188                                              gsize                 length);
 189 void      g_key_file_set_comment            (GKeyFile             *key_file,
 190                                              const gchar          *group_name,
 191                                              const gchar          *key,
 192                                              const gchar          *comment,
 193                                              GError              **error);
 194 gchar    *g_key_file_get_comment            (GKeyFile             *key_file,
 195                                              const gchar          *group_name,
 196                                              const gchar          *key,
 197                                              GError              **error) G_GNUC_MALLOC;
 198
 199 void      g_key_file_remove_comment         (GKeyFile             *key_file,
 200                                              const gchar          *group_name,
 201                                              const gchar          *key,
 202                                              GError              **error);
 203 void      g_key_file_remove_key             (GKeyFile             *key_file,
 204                                              const gchar          *group_name,
 205                                              const gchar          *key,
 206                                              GError              **error);
 207 void      g_key_file_remove_group           (GKeyFile             *key_file,
 208                                              const gchar          *group_name,
 209                                              GError              **error);
 210
 211 G_END_DECLS
 212
 213 #endif /* __G_KEY_FILE_H__ */