1 /* Fo
2 * fo-property-score-spaces.c: 'score-spaces' property
3 *
4 * Copyright (C) 2001-2005 Sun Microsystems
5 * Copyright (C) 2007 Menteith Consulting Ltd
6 *
7 * See COPYING for the status of this software.
8 */
9
10 #include <string.h>
11 #include "fo-utils.h"
12 #include "fo-context.h"
13 #include "datatype/fo-datatype.h"
14 #include "property/fo-property-private.h"
15 #include "property/fo-property-font-size.h"
16 #include "property/fo-property-score-spaces.h"
17
18 /* score-spaces */
19 /* Inherited: TRUE */
20 /* Shorthand: FALSE */
21 /* true | false | inherit */
22 /* Initial value: true */
23
24 struct _FoPropertyScoreSpaces
25 {
26 FoProperty parent_instance;
27 };
28
29 struct _FoPropertyScoreSpacesClass
30 {
31 FoPropertyClass parent_class;
32 };
33
34 static void fo_property_score_spaces_init (FoPropertyScoreSpaces *property_score_spaces);
35 static void fo_property_score_spaces_class_init (FoPropertyScoreSpacesClass *klass);
36 static void fo_property_score_spaces_finalize (GObject *object);
37
38 static FoDatatype * fo_property_score_spaces_resolve_enum (const gchar *token,
39 FoContext *context,
40 GError **error);
41 static FoDatatype * fo_property_score_spaces_validate (FoDatatype *datatype,
42 FoContext *context,
43 GError **error);
44
45 static const gchar class_name[] = "score-spaces";
46 static gpointer parent_class;
47
48 /**
49 * fo_property_score_spaces_get_type:
50 *
51 * Register the #FoPropertyScoreSpaces type if not already registered and
52 * return its #GType value.
53 *
54 * Return value: #GType of #FoPropertyScoreSpaces.
55 **/
56 GType
fo_property_score_spaces_get_type(void)57 fo_property_score_spaces_get_type (void)
58 {
59 static GType object_type = 0;
60
61 if (!object_type)
62 {
63 static const GTypeInfo object_info =
64 {
65 sizeof (FoPropertyScoreSpacesClass),
66 NULL, /* base_init */
67 NULL, /* base_finalize */
68 (GClassInitFunc) fo_property_score_spaces_class_init,
69 NULL, /* class_finalize */
70 NULL, /* class_data */
71 sizeof (FoPropertyScoreSpaces),
72 0, /* n_preallocs */
73 (GInstanceInitFunc) fo_property_score_spaces_init,
74 NULL /* value_table */
75 };
76
77 object_type = g_type_register_static (FO_TYPE_PROPERTY,
78 class_name,
79 &object_info, 0);
80 }
81
82 return object_type;
83 }
84
85 /**
86 * fo_property_score_spaces_init:
87 * @score_spaces: #FoPropertyScoreSpaces object to initialise.
88 *
89 * Implements #GInstanceInitFunc for #FoPropertyScoreSpaces.
90 **/
91 void
fo_property_score_spaces_init(FoPropertyScoreSpaces * score_spaces)92 fo_property_score_spaces_init (FoPropertyScoreSpaces *score_spaces)
93 {
94 FO_PROPERTY (score_spaces)->value =
95 g_object_ref (fo_enum_factory_get_enum_by_nick ("true"));
96 }
97
98 /**
99 * fo_property_score_spaces_class_init:
100 * @klass: #FoPropertyScoreSpacesClass object to initialise.
101 *
102 * Implements #GClassInitFunc for #FoPropertyScoreSpacesClass.
103 **/
104 void
fo_property_score_spaces_class_init(FoPropertyScoreSpacesClass * klass)105 fo_property_score_spaces_class_init (FoPropertyScoreSpacesClass *klass)
106 {
107 GObjectClass *object_class = G_OBJECT_CLASS (klass);
108 FoPropertyClass *property_class = FO_PROPERTY_CLASS (klass);
109
110 parent_class = g_type_class_peek_parent (klass);
111
112 object_class->finalize = fo_property_score_spaces_finalize;
113
114 property_class->is_inherited = TRUE;
115 property_class->is_shorthand = FALSE;
116 property_class->resolve_enum =
117 fo_property_score_spaces_resolve_enum;
118 property_class->validate =
119 fo_property_score_spaces_validate;
120 property_class->get_initial =
121 fo_property_score_spaces_get_initial;
122 }
123
124 /**
125 * fo_property_score_spaces_finalize:
126 * @object: #FoPropertyScoreSpaces object to finalize.
127 *
128 * Implements #GObjectFinalizeFunc for #FoPropertyScoreSpaces.
129 **/
130 void
fo_property_score_spaces_finalize(GObject * object)131 fo_property_score_spaces_finalize (GObject *object)
132 {
133 FoPropertyScoreSpaces *score_spaces;
134
135 score_spaces = FO_PROPERTY_SCORE_SPACES (object);
136
137 G_OBJECT_CLASS (parent_class)->finalize (object);
138 }
139
140
141 /**
142 * fo_property_score_spaces_new:
143 *
144 * Creates a new #FoPropertyScoreSpaces initialized to default value.
145 *
146 * Return value: the new #FoPropertyScoreSpaces.
147 **/
148 FoProperty*
fo_property_score_spaces_new(void)149 fo_property_score_spaces_new (void)
150 {
151 FoProperty* score_spaces;
152
153 score_spaces =
154 FO_PROPERTY (g_object_new (fo_property_score_spaces_get_type (),
155 NULL));
156
157 return score_spaces;
158 }
159
160 /**
161 * fo_property_score_spaces_resolve_enum:
162 * @token: Token from the XML attribute value to be evaluated as an
163 * enumeration token.
164 * @context: #FoContext object from which to possibly inherit values.
165 * @error: Information about any error that has occurred.
166 *
167 * Compare @token against the enumeration tokens that are valid for the
168 * current FO property. If @token is valid, returns either an #FoEnum datatype
169 * representing the enumeration token or a different datatype representing
170 * the enumeration token's resolved value. If @token is not valid,
171 * sets @error and returns NULL.
172 *
173 * Return value: Resolved enumeration value or NULL.
174 **/
175 FoDatatype*
fo_property_score_spaces_resolve_enum(const gchar * token,FoContext * context,GError ** error)176 fo_property_score_spaces_resolve_enum (const gchar *token,
177 FoContext *context,
178 GError **error)
179 {
180 g_return_val_if_fail (token != NULL, NULL);
181 g_return_val_if_fail (FO_IS_CONTEXT (context), NULL);
182 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
183
184 if ((strcmp (token, "true") == 0) ||
185 (strcmp (token, "false") == 0))
186 {
187 return g_object_ref (fo_enum_factory_get_enum_by_nick (token));
188 }
189 else
190 {
191 g_set_error (error,
192 FO_FO_ERROR,
193 FO_FO_ERROR_ENUMERATION_TOKEN,
194 _(fo_fo_error_messages[FO_FO_ERROR_ENUMERATION_TOKEN]),
195 class_name,
196 token);
197 return NULL;
198 }
199 }
200
201 /**
202 * fo_property_score_spaces_validate:
203 * @datatype: #FoDatatype to be validated against allowed datatypes and
204 * values for current property.
205 * @context: #FoContext object from which to possibly inherit values.
206 * @error: Information about any error that has occurred.
207 *
208 * Validates @datatype against allowed values. Returns @datatype, a
209 * replacement datatype value, or NULL if validation failed.
210 *
211 * Return value: Valid datatype value or NULL.
212 **/
213 FoDatatype*
fo_property_score_spaces_validate(FoDatatype * datatype,FoContext * context,GError ** error)214 fo_property_score_spaces_validate (FoDatatype *datatype,
215 FoContext *context,
216 GError **error)
217 {
218 FoDatatype *new_datatype;
219 GError *tmp_error = NULL;
220 gchar *token;
221
222 g_return_val_if_fail (datatype != NULL, NULL);
223 g_return_val_if_fail (FO_IS_DATATYPE (datatype), NULL);
224 g_return_val_if_fail (context != NULL, NULL);
225 g_return_val_if_fail (FO_IS_CONTEXT (context), NULL);
226 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
227
228 if (FO_IS_ENUM (datatype))
229 {
230 FoEnumEnum value = fo_enum_get_value (datatype);
231
232 if ((value == FO_ENUM_ENUM_TRUE) ||
233 (value == FO_ENUM_ENUM_FALSE))
234 {
235 return datatype;
236 }
237 else
238 {
239 gchar *datatype_sprintf = fo_object_sprintf (datatype);
240
241 g_set_error (error,
242 FO_FO_ERROR,
243 FO_FO_ERROR_ENUMERATION_TOKEN,
244 _(fo_fo_error_messages[FO_FO_ERROR_ENUMERATION_TOKEN]),
245 class_name,
246 datatype_sprintf,
247 g_type_name (G_TYPE_FROM_INSTANCE (datatype)));
248
249 g_object_unref (datatype);
250
251 g_free (datatype_sprintf);
252
253 return NULL;
254 }
255 }
256 else if (FO_IS_STRING (datatype))
257 {
258 token = fo_string_get_value (datatype);
259
260 new_datatype =
261 fo_property_score_spaces_resolve_enum (token, context, &tmp_error);
262
263 g_object_unref (datatype);
264
265 fo_propagate_and_return_val_if_error (error, tmp_error, NULL);
266
267 return new_datatype;
268 }
269 else if (FO_IS_NAME (datatype))
270 {
271 token = fo_name_get_value (datatype);
272
273 new_datatype =
274 fo_property_score_spaces_resolve_enum (token, context, &tmp_error);
275
276 g_object_unref (datatype);
277
278 fo_propagate_and_return_val_if_error (error, tmp_error, NULL);
279
280 return new_datatype;
281 }
282 else
283 {
284 gchar *datatype_sprintf = fo_object_sprintf (datatype);
285
286 g_set_error (error,
287 FO_FO_ERROR,
288 FO_FO_ERROR_DATATYPE,
289 _(fo_fo_error_messages[FO_FO_ERROR_DATATYPE]),
290 class_name,
291 datatype_sprintf,
292 g_type_name (G_TYPE_FROM_INSTANCE (datatype)));
293
294 g_object_unref (datatype);
295
296 g_free (datatype_sprintf);
297
298 return NULL;
299 }
300 }
301
302 /**
303 * fo_property_score_spaces_get_initial:
304 *
305 * Get an instance of the property with the correct initial value.
306 *
307 * Return value: An instance of the property.
308 **/
309 FoProperty*
fo_property_score_spaces_get_initial(void)310 fo_property_score_spaces_get_initial (void)
311 {
312 static FoProperty *score_spaces = NULL;
313
314 if (score_spaces == NULL)
315 {
316 score_spaces =
317 fo_property_score_spaces_new ();
318 }
319
320 return score_spaces;
321 }
322