?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updates
[glib.git] / glib / gkeyfile.h
blobb19124c35d188446a5e7014f5be86bb3a3e4b448
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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
24 #error "Only <glib.h> can be included directly."
25 #endif
26
27 #ifndef __G_KEY_FILE_H__
28 #define __G_KEY_FILE_H__
29
30 #include <glib/gerror.h>
31
32 G_BEGIN_DECLS
33
34 typedef enum
35 {
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
42 } GKeyFileError;
43
44 #define G_KEY_FILE_ERROR g_key_file_error_quark()
45
46 GQuark g_key_file_error_quark (void);
47
48 typedef struct _GKeyFile GKeyFile;
49
50 typedef enum
51 {
52 G_KEY_FILE_NONE = 0,
53 G_KEY_FILE_KEEP_COMMENTS = 1 << 0,
54 G_KEY_FILE_KEEP_TRANSLATIONS = 1 << 1
55 } GKeyFileFlags;
56
57 GKeyFile *g_key_file_new (void);
58 void g_key_file_free (GKeyFile *key_file);
59 void g_key_file_set_list_separator (GKeyFile *key_file,
60 gchar separator);
61 gboolean g_key_file_load_from_file (GKeyFile *key_file,
62 const gchar *file,
63 GKeyFileFlags flags,
64 GError **error);
65 gboolean g_key_file_load_from_data (GKeyFile *key_file,
66 const gchar *data,
67 gsize length,
68 GKeyFileFlags flags,
69 GError **error);
70 gboolean g_key_file_load_from_dirs (GKeyFile *key_file,
71 const gchar *file,
72 const gchar **search_dirs,
73 gchar **full_path,
74 GKeyFileFlags flags,
75 GError **error);
76 gboolean g_key_file_load_from_data_dirs (GKeyFile *key_file,
77 const gchar *file,
78 gchar **full_path,
79 GKeyFileFlags flags,
80 GError **error);
81 gchar *g_key_file_to_data (GKeyFile *key_file,
82 gsize *length,
83 GError **error) G_GNUC_MALLOC;
84 gchar *g_key_file_get_start_group (GKeyFile *key_file) G_GNUC_MALLOC;
85 gchar **g_key_file_get_groups (GKeyFile *key_file,
86 gsize *length) G_GNUC_MALLOC;
87 gchar **g_key_file_get_keys (GKeyFile *key_file,
88 const gchar *group_name,
89 gsize *length,
90 GError **error) G_GNUC_MALLOC;
91 gboolean g_key_file_has_group (GKeyFile *key_file,
92 const gchar *group_name);
93 gboolean g_key_file_has_key (GKeyFile *key_file,
94 const gchar *group_name,
95 const gchar *key,
96 GError **error);
97 gchar *g_key_file_get_value (GKeyFile *key_file,
98 const gchar *group_name,
99 const gchar *key,
100 GError **error) G_GNUC_MALLOC;
101 void g_key_file_set_value (GKeyFile *key_file,
102 const gchar *group_name,
103 const gchar *key,
104 const gchar *value);
105 gchar *g_key_file_get_string (GKeyFile *key_file,
106 const gchar *group_name,
107 const gchar *key,
108 GError **error) G_GNUC_MALLOC;
109 void g_key_file_set_string (GKeyFile *key_file,
110 const gchar *group_name,
111 const gchar *key,
112 const gchar *string);
113 gchar *g_key_file_get_locale_string (GKeyFile *key_file,
114 const gchar *group_name,
115 const gchar *key,
116 const gchar *locale,
117 GError **error) G_GNUC_MALLOC;
118 void g_key_file_set_locale_string (GKeyFile *key_file,
119 const gchar *group_name,
120 const gchar *key,
121 const gchar *locale,
122 const gchar *string);
123 gboolean g_key_file_get_boolean (GKeyFile *key_file,
124 const gchar *group_name,
125 const gchar *key,
126 GError **error);
127 void g_key_file_set_boolean (GKeyFile *key_file,
128 const gchar *group_name,
129 const gchar *key,
130 gboolean value);
131 gint g_key_file_get_integer (GKeyFile *key_file,
132 const gchar *group_name,
133 const gchar *key,
134 GError **error);
135 void g_key_file_set_integer (GKeyFile *key_file,
136 const gchar *group_name,
137 const gchar *key,
138 gint value);
139 gdouble g_key_file_get_double (GKeyFile *key_file,
140 const gchar *group_name,
141 const gchar *key,
142 GError **error);
143 void g_key_file_set_double (GKeyFile *key_file,
144 const gchar *group_name,
145 const gchar *key,
146 gdouble value);
147 gchar **g_key_file_get_string_list (GKeyFile *key_file,
148 const gchar *group_name,
149 const gchar *key,
150 gsize *length,
151 GError **error) G_GNUC_MALLOC;
152 void g_key_file_set_string_list (GKeyFile *key_file,
153 const gchar *group_name,
154 const gchar *key,
155 const gchar * const list[],
156 gsize length);
157 gchar **g_key_file_get_locale_string_list (GKeyFile *key_file,
158 const gchar *group_name,
159 const gchar *key,
160 const gchar *locale,
161 gsize *length,
162 GError **error) G_GNUC_MALLOC;
163 void g_key_file_set_locale_string_list (GKeyFile *key_file,
164 const gchar *group_name,
165 const gchar *key,
166 const gchar *locale,
167 const gchar * const list[],
168 gsize length);
169 gboolean *g_key_file_get_boolean_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_boolean_list (GKeyFile *key_file,
175 const gchar *group_name,
176 const gchar *key,
177 gboolean list[],
178 gsize length);
179 gint *g_key_file_get_integer_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_double_list (GKeyFile *key_file,
185 const gchar *group_name,
186 const gchar *key,
187 gdouble list[],
188 gsize length);
189 gdouble *g_key_file_get_double_list (GKeyFile *key_file,
190 const gchar *group_name,
191 const gchar *key,
192 gsize *length,
193 GError **error) G_GNUC_MALLOC;
194 void g_key_file_set_integer_list (GKeyFile *key_file,
195 const gchar *group_name,
196 const gchar *key,
197 gint list[],
198 gsize length);
199 gboolean g_key_file_set_comment (GKeyFile *key_file,
200 const gchar *group_name,
201 const gchar *key,
202 const gchar *comment,
203 GError **error);
204 gchar *g_key_file_get_comment (GKeyFile *key_file,
205 const gchar *group_name,
206 const gchar *key,
207 GError **error) G_GNUC_MALLOC;
208
209 gboolean g_key_file_remove_comment (GKeyFile *key_file,
210 const gchar *group_name,
211 const gchar *key,
212 GError **error);
213 gboolean g_key_file_remove_key (GKeyFile *key_file,
214 const gchar *group_name,
215 const gchar *key,
216 GError **error);
217 gboolean g_key_file_remove_group (GKeyFile *key_file,
218 const gchar *group_name,
219 GError **error);
220
221 /* Defines for handling freedesktop.org Desktop files */
222 #define G_KEY_FILE_DESKTOP_GROUP "Desktop Entry"
223
224 #define G_KEY_FILE_DESKTOP_KEY_TYPE "Type"
225 #define G_KEY_FILE_DESKTOP_KEY_VERSION "Version"
226 #define G_KEY_FILE_DESKTOP_KEY_NAME "Name"
227 #define G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME "GenericName"
228 #define G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY "NoDisplay"
229 #define G_KEY_FILE_DESKTOP_KEY_COMMENT "Comment"
230 #define G_KEY_FILE_DESKTOP_KEY_ICON "Icon"
231 #define G_KEY_FILE_DESKTOP_KEY_HIDDEN "Hidden"
232 #define G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN "OnlyShowIn"
233 #define G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN "NotShowIn"
234 #define G_KEY_FILE_DESKTOP_KEY_TRY_EXEC "TryExec"
235 #define G_KEY_FILE_DESKTOP_KEY_EXEC "Exec"
236 #define G_KEY_FILE_DESKTOP_KEY_PATH "Path"
237 #define G_KEY_FILE_DESKTOP_KEY_TERMINAL "Terminal"
238 #define G_KEY_FILE_DESKTOP_KEY_MIME_TYPE "MimeType"
239 #define G_KEY_FILE_DESKTOP_KEY_CATEGORIES "Categories"
240 #define G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY "StartupNotify"
241 #define G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS "StartupWMClass"
242 #define G_KEY_FILE_DESKTOP_KEY_URL "URL"
243
244 #define G_KEY_FILE_DESKTOP_TYPE_APPLICATION "Application"
245 #define G_KEY_FILE_DESKTOP_TYPE_LINK "Link"
246 #define G_KEY_FILE_DESKTOP_TYPE_DIRECTORY "Directory"
247
248 G_END_DECLS
249
250 #endif /* __G_KEY_FILE_H__ */
glib mirror