2 * Copyright © 2008-2009 Ryan Lortie
3 * Copyright © 2010 Codethink Limited
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the licence, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Author: Ryan Lortie <desrt@desrt.ca>
23 #include "dconf-paths.h"
25 #include "dconf-error.h"
30 * @short_description: utility functions to validate dconf paths
32 * Various places in the dconf API speak of "paths", "keys", "dirs" and
33 * relative versions of each of these. This file contains functions to
34 * check if a given string is a valid member of each of these classes
35 * and to report errors when a string is not.
37 * See each function in this section for a precise description of what
38 * makes a string a valid member of a given class.
41 #define vars gchar c, l
44 if (string == NULL) { \
45 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
46 "%s not specified", type); \
52 if ((l = *string++) != '/') \
54 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
55 "dconf %s must begin with a slash", type); \
62 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
63 "dconf %s must not begin with a slash", type); \
68 #define no_double_slash \
69 while ((c = *string++)) \
71 if (c == '/' && l == '/') \
73 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
74 "dconf %s must not contain two " \
75 "consecutive slashes", type); \
87 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
88 "dconf %s must not end with a slash", type); \
96 g_set_error (error, DCONF_ERROR, DCONF_ERROR_PATH, \
97 "dconf %s must end with a slash", type); \
107 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
109 * Checks if @string is a valid dconf path. dconf keys must start with
110 * '/' and not contain '//'.
112 * A dconf path may be either a key or a dir. See dconf_is_key() and
113 * dconf_is_dir() for examples of each.
115 * Returns: %TRUE if @string is a path
118 dconf_is_path (const gchar
*string
,
122 vars
; nonnull
; absolute
; no_double_slash
; path
;
129 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
131 * Checks if @string is a valid dconf key. dconf keys must start with
132 * '/', not contain '//' and not end with '/'.
134 * A dconf key is the potential location of a single value within the
137 * "/a", "/a/b" and "/a/b/c" are examples of keys. "", "/", "a", "a/b",
138 * "//a/b", "/a//b", and "/a/" are examples of strings that are not
141 * Returns: %TRUE if @string is a key
144 dconf_is_key (const gchar
*string
,
148 vars
; nonnull
; absolute
; no_double_slash
; key
;
155 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
157 * Checks if @string is a valid dconf dir. dconf dirs must start and
158 * end with '/' and not contain '//'.
160 * A dconf dir refers to a subtree of the database that can contain
161 * other dirs or keys. If @string is a dir, then it will be a prefix of
162 * any key or dir contained within it.
164 * "/", "/a/" and "/a/b/" are examples of dirs. "", "a/", "a/b/",
165 * "//a/b/", "/a//b/" and "/a" are examples of strings that are not
168 * Returns: %TRUE if @string is a dir
171 dconf_is_dir (const gchar
*string
,
175 vars
; nonnull
; absolute
; no_double_slash
; dir
;
182 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
184 * Checks if @string is a valid dconf relative path. A relative path is
185 * a string that, when concatenated to a dir, forms a valid dconf path.
186 * This means that a rel must not start with a '/' or contain '//'.
188 * A dconf rel may be either a relative key or a relative dir. See
189 * dconf_is_rel_key() and dconf_is_rel_dir() for examples of each.
191 * Returns: %TRUE if @string is a relative path
194 dconf_is_rel_path (const gchar
*string
,
197 #define type "relative path"
198 vars
; nonnull
; relative
; no_double_slash
; path
;
206 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
208 * Checks if @string is a valid dconf relative key. A relative key is a
209 * string that, when concatenated to a dir, forms a valid dconf key.
210 * This means that a relative key must not start or end with a '/' or
213 * "a", "a/b" and "a/b/c" are examples of relative keys. "", "/", "/a",
214 * "/a/b", "//a/b", "/a//b", and "a/" are examples of strings that are
217 * Returns: %TRUE if @string is a relative key
220 dconf_is_rel_key (const gchar
*string
,
223 #define type "relative key"
224 vars
; nonnull
; relative
; no_double_slash
; key
;
231 * @error: a pointer to a #GError, or %NULL, set when %FALSE is returned
233 * Checks if @string is a valid dconf relative dir. A relative dir is a
234 * string that, when appended to a dir, forms a valid dconf dir. This
235 * means that a relative dir must not start with a '/' or contain '//'
236 * and must end with a '/' except in the case that it is the empty
237 * string (in which case the path specified by appending the rel to a
238 * directory is the original directory).
240 * "", "a/" and "a/b/" are examples of relative dirs. "/", "/a/",
241 * "/a/b/", "//a/b/", "a//b/" and "a" are examples of strings that are
244 * Returns: %TRUE if @string is a relative dir
247 dconf_is_rel_dir (const gchar
*string
,
250 #define type "relative dir"
251 vars
; nonnull
; relative
; no_double_slash
; dir
;