1 /* gkeyfile.h - desktop entry file parser
3 * Copyright 2004 Red Hat, Inc.
5 * Ray Strode <halfline@hawaii.rr.com>
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.
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.
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.
23 #ifndef __G_KEY_FILE_H__
24 #define __G_KEY_FILE_H__
26 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
27 #error "Only <glib.h> can be included directly."
30 #include <glib/gerror.h>
36 G_KEY_FILE_ERROR_UNKNOWN_ENCODING,
37 G_KEY_FILE_ERROR_PARSE,
38 G_KEY_FILE_ERROR_NOT_FOUND,
39 G_KEY_FILE_ERROR_KEY_NOT_FOUND,
40 G_KEY_FILE_ERROR_GROUP_NOT_FOUND,
41 G_KEY_FILE_ERROR_INVALID_VALUE
44 #define G_KEY_FILE_ERROR g_key_file_error_quark()
47 GQuark g_key_file_error_quark (void);
49 typedef struct _GKeyFile GKeyFile;
54 G_KEY_FILE_KEEP_COMMENTS = 1 << 0,
55 G_KEY_FILE_KEEP_TRANSLATIONS = 1 << 1
59 GKeyFile *g_key_file_new (void);
61 GKeyFile *g_key_file_ref (GKeyFile *key_file);
63 void g_key_file_unref (GKeyFile *key_file);
65 void g_key_file_free (GKeyFile *key_file);
67 void g_key_file_set_list_separator (GKeyFile *key_file,
70 gboolean g_key_file_load_from_file (GKeyFile *key_file,
75 gboolean g_key_file_load_from_data (GKeyFile *key_file,
81 gboolean g_key_file_load_from_dirs (GKeyFile *key_file,
83 const gchar **search_dirs,
88 gboolean g_key_file_load_from_data_dirs (GKeyFile *key_file,
94 gchar *g_key_file_to_data (GKeyFile *key_file,
96 GError **error) G_GNUC_MALLOC;
98 gchar *g_key_file_get_start_group (GKeyFile *key_file) G_GNUC_MALLOC;
100 gchar **g_key_file_get_groups (GKeyFile *key_file,
101 gsize *length) G_GNUC_MALLOC;
102 GLIB_AVAILABLE_IN_ALL
103 gchar **g_key_file_get_keys (GKeyFile *key_file,
104 const gchar *group_name,
106 GError **error) G_GNUC_MALLOC;
107 GLIB_AVAILABLE_IN_ALL
108 gboolean g_key_file_has_group (GKeyFile *key_file,
109 const gchar *group_name);
110 GLIB_AVAILABLE_IN_ALL
111 gboolean g_key_file_has_key (GKeyFile *key_file,
112 const gchar *group_name,
115 GLIB_AVAILABLE_IN_ALL
116 gchar *g_key_file_get_value (GKeyFile *key_file,
117 const gchar *group_name,
119 GError **error) G_GNUC_MALLOC;
120 GLIB_AVAILABLE_IN_ALL
121 void g_key_file_set_value (GKeyFile *key_file,
122 const gchar *group_name,
125 GLIB_AVAILABLE_IN_ALL
126 gchar *g_key_file_get_string (GKeyFile *key_file,
127 const gchar *group_name,
129 GError **error) G_GNUC_MALLOC;
130 GLIB_AVAILABLE_IN_ALL
131 void g_key_file_set_string (GKeyFile *key_file,
132 const gchar *group_name,
134 const gchar *string);
135 GLIB_AVAILABLE_IN_ALL
136 gchar *g_key_file_get_locale_string (GKeyFile *key_file,
137 const gchar *group_name,
140 GError **error) G_GNUC_MALLOC;
141 GLIB_AVAILABLE_IN_ALL
142 void g_key_file_set_locale_string (GKeyFile *key_file,
143 const gchar *group_name,
146 const gchar *string);
147 GLIB_AVAILABLE_IN_ALL
148 gboolean g_key_file_get_boolean (GKeyFile *key_file,
149 const gchar *group_name,
152 GLIB_AVAILABLE_IN_ALL
153 void g_key_file_set_boolean (GKeyFile *key_file,
154 const gchar *group_name,
157 GLIB_AVAILABLE_IN_ALL
158 gint g_key_file_get_integer (GKeyFile *key_file,
159 const gchar *group_name,
162 GLIB_AVAILABLE_IN_ALL
163 void g_key_file_set_integer (GKeyFile *key_file,
164 const gchar *group_name,
167 GLIB_AVAILABLE_IN_ALL
168 gint64 g_key_file_get_int64 (GKeyFile *key_file,
169 const gchar *group_name,
172 GLIB_AVAILABLE_IN_ALL
173 void g_key_file_set_int64 (GKeyFile *key_file,
174 const gchar *group_name,
177 GLIB_AVAILABLE_IN_ALL
178 guint64 g_key_file_get_uint64 (GKeyFile *key_file,
179 const gchar *group_name,
182 GLIB_AVAILABLE_IN_ALL
183 void g_key_file_set_uint64 (GKeyFile *key_file,
184 const gchar *group_name,
187 GLIB_AVAILABLE_IN_ALL
188 gdouble g_key_file_get_double (GKeyFile *key_file,
189 const gchar *group_name,
192 GLIB_AVAILABLE_IN_ALL
193 void g_key_file_set_double (GKeyFile *key_file,
194 const gchar *group_name,
197 GLIB_AVAILABLE_IN_ALL
198 gchar **g_key_file_get_string_list (GKeyFile *key_file,
199 const gchar *group_name,
202 GError **error) G_GNUC_MALLOC;
203 GLIB_AVAILABLE_IN_ALL
204 void g_key_file_set_string_list (GKeyFile *key_file,
205 const gchar *group_name,
207 const gchar * const list[],
209 GLIB_AVAILABLE_IN_ALL
210 gchar **g_key_file_get_locale_string_list (GKeyFile *key_file,
211 const gchar *group_name,
215 GError **error) G_GNUC_MALLOC;
216 GLIB_AVAILABLE_IN_ALL
217 void g_key_file_set_locale_string_list (GKeyFile *key_file,
218 const gchar *group_name,
221 const gchar * const list[],
223 GLIB_AVAILABLE_IN_ALL
224 gboolean *g_key_file_get_boolean_list (GKeyFile *key_file,
225 const gchar *group_name,
228 GError **error) G_GNUC_MALLOC;
229 GLIB_AVAILABLE_IN_ALL
230 void g_key_file_set_boolean_list (GKeyFile *key_file,
231 const gchar *group_name,
235 GLIB_AVAILABLE_IN_ALL
236 gint *g_key_file_get_integer_list (GKeyFile *key_file,
237 const gchar *group_name,
240 GError **error) G_GNUC_MALLOC;
241 GLIB_AVAILABLE_IN_ALL
242 void g_key_file_set_double_list (GKeyFile *key_file,
243 const gchar *group_name,
247 GLIB_AVAILABLE_IN_ALL
248 gdouble *g_key_file_get_double_list (GKeyFile *key_file,
249 const gchar *group_name,
252 GError **error) G_GNUC_MALLOC;
253 GLIB_AVAILABLE_IN_ALL
254 void g_key_file_set_integer_list (GKeyFile *key_file,
255 const gchar *group_name,
259 GLIB_AVAILABLE_IN_ALL
260 gboolean g_key_file_set_comment (GKeyFile *key_file,
261 const gchar *group_name,
263 const gchar *comment,
265 GLIB_AVAILABLE_IN_ALL
266 gchar *g_key_file_get_comment (GKeyFile *key_file,
267 const gchar *group_name,
269 GError **error) G_GNUC_MALLOC;
271 GLIB_AVAILABLE_IN_ALL
272 gboolean g_key_file_remove_comment (GKeyFile *key_file,
273 const gchar *group_name,
276 GLIB_AVAILABLE_IN_ALL
277 gboolean g_key_file_remove_key (GKeyFile *key_file,
278 const gchar *group_name,
281 GLIB_AVAILABLE_IN_ALL
282 gboolean g_key_file_remove_group (GKeyFile *key_file,
283 const gchar *group_name,
286 /* Defines for handling freedesktop.org Desktop files */
287 #define G_KEY_FILE_DESKTOP_GROUP "Desktop Entry"
289 #define G_KEY_FILE_DESKTOP_KEY_TYPE "Type"
290 #define G_KEY_FILE_DESKTOP_KEY_VERSION "Version"
291 #define G_KEY_FILE_DESKTOP_KEY_NAME "Name"
292 #define G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME "GenericName"
293 #define G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY "NoDisplay"
294 #define G_KEY_FILE_DESKTOP_KEY_COMMENT "Comment"
295 #define G_KEY_FILE_DESKTOP_KEY_ICON "Icon"
296 #define G_KEY_FILE_DESKTOP_KEY_HIDDEN "Hidden"
297 #define G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN "OnlyShowIn"
298 #define G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN "NotShowIn"
299 #define G_KEY_FILE_DESKTOP_KEY_TRY_EXEC "TryExec"
300 #define G_KEY_FILE_DESKTOP_KEY_EXEC "Exec"
301 #define G_KEY_FILE_DESKTOP_KEY_PATH "Path"
302 #define G_KEY_FILE_DESKTOP_KEY_TERMINAL "Terminal"
303 #define G_KEY_FILE_DESKTOP_KEY_MIME_TYPE "MimeType"
304 #define G_KEY_FILE_DESKTOP_KEY_CATEGORIES "Categories"
305 #define G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY "StartupNotify"
306 #define G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS "StartupWMClass"
307 #define G_KEY_FILE_DESKTOP_KEY_URL "URL"
309 #define G_KEY_FILE_DESKTOP_TYPE_APPLICATION "Application"
310 #define G_KEY_FILE_DESKTOP_TYPE_LINK "Link"
311 #define G_KEY_FILE_DESKTOP_TYPE_DIRECTORY "Directory"
315 #endif /* __G_KEY_FILE_H__ */