1 /* Fo
2 * fo-property-block-progression-dimension.c: 'block-progression-dimension' property
3 *
4 * Copyright (C) 2001 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-block-progression-dimension.h"
17
18 /* block-progression-dimension */
19 /* Inherited: FALSE */
20 /* Shorthand: FALSE */
21 /* auto | <length> | <percentage> | <length-range> | inherit */
22 /* Initial value: auto */
23
24 struct _FoPropertyBlockProgressionDimension
25 {
26 FoProperty parent_instance;
27 };
28
29 struct _FoPropertyBlockProgressionDimensionClass
30 {
31 FoPropertyClass parent_class;
32 };
33
34 static void fo_property_block_progression_dimension_init (FoPropertyBlockProgressionDimension *property_block_progression_dimension);
35 static void fo_property_block_progression_dimension_class_init (FoPropertyBlockProgressionDimensionClass *klass);
36 static void fo_property_block_progression_dimension_finalize (GObject *object);
37
38 static FoDatatype* fo_property_block_progression_dimension_resolve_enum (const gchar *token,
39 FoContext *context,
40 GError **error);
41 static FoDatatype* fo_property_block_progression_dimension_validate (FoDatatype *datatype,
42 FoContext *context,
43 GError **error);
44
45 static const gchar class_name[] = "block-progression-dimension";
46 static gpointer parent_class;
47
48 /**
49 * fo_property_block_progression_dimension_get_type:
50 *
51 * Register the #FoPropertyBlockProgressionDimension type if not already registered and
52 * return its #GType value.
53 *
54 * Return value: #GType of #FoPropertyBlockProgressionDimension.
55 **/
56 GType
fo_property_block_progression_dimension_get_type(void)57 fo_property_block_progression_dimension_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 (FoPropertyBlockProgressionDimensionClass),
66 NULL, /* base_init */
67 NULL, /* base_finalize */
68 (GClassInitFunc) fo_property_block_progression_dimension_class_init,
69 NULL, /* class_finalize */
70 NULL, /* class_data */
71 sizeof (FoPropertyBlockProgressionDimension),
72 0, /* n_preallocs */
73 (GInstanceInitFunc) fo_property_block_progression_dimension_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_block_progression_dimension_init:
87 * @block_progression_dimension: #FoPropertyBlockProgressionDimension object to initialise.
88 *
89 * Implements #GInstanceInitFunc for #FoPropertyBlockProgressionDimension.
90 **/
91 void
fo_property_block_progression_dimension_init(FoPropertyBlockProgressionDimension * block_progression_dimension)92 fo_property_block_progression_dimension_init (FoPropertyBlockProgressionDimension *block_progression_dimension)
93 {
94 FO_PROPERTY (block_progression_dimension)->value =
95 g_object_ref (fo_length_range_new_auto ());
96 }
97
98 /**
99 * fo_property_block_progression_dimension_class_init:
100 * @klass: #FoPropertyBlockProgressionDimensionClass object to initialise.
101 *
102 * Implements #GClassInitFunc for #FoPropertyBlockProgressionDimensionClass.
103 **/
104 void
fo_property_block_progression_dimension_class_init(FoPropertyBlockProgressionDimensionClass * klass)105 fo_property_block_progression_dimension_class_init (FoPropertyBlockProgressionDimensionClass *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_block_progression_dimension_finalize;
113
114 property_class->is_inherited = FALSE;
115 property_class->is_shorthand = FALSE;
116 property_class->resolve_enum =
117 fo_property_block_progression_dimension_resolve_enum;
118 property_class->validate =
119 fo_property_block_progression_dimension_validate;
120 property_class->get_initial =
121 fo_property_block_progression_dimension_get_initial;
122 }
123
124 /**
125 * fo_property_block_progression_dimension_finalize:
126 * @object: #FoPropertyBlockProgressionDimension object to finalize.
127 *
128 * Implements #GObjectFinalizeFunc for #FoPropertyBlockProgressionDimension.
129 **/
130 void
fo_property_block_progression_dimension_finalize(GObject * object)131 fo_property_block_progression_dimension_finalize (GObject *object)
132 {
133 FoPropertyBlockProgressionDimension *block_progression_dimension;
134
135 block_progression_dimension = FO_PROPERTY_BLOCK_PROGRESSION_DIMENSION (object);
136
137 G_OBJECT_CLASS (parent_class)->finalize (object);
138 }
139
140
141 /**
142 * fo_property_block_progression_dimension_new:
143 *
144 * Creates a new #FoPropertyBlockProgressionDimension initialized to default value.
145 *
146 * Return value: the new #FoPropertyBlockProgressionDimension.
147 **/
148 FoProperty*
fo_property_block_progression_dimension_new(void)149 fo_property_block_progression_dimension_new (void)
150 {
151 FoProperty* block_progression_dimension;
152
153 block_progression_dimension =
154 FO_PROPERTY (g_object_new (fo_property_block_progression_dimension_get_type (),
155 NULL));
156
157 return block_progression_dimension;
158 }
159
160 /**
161 * fo_property_block_progression_dimension_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_block_progression_dimension_resolve_enum(const gchar * token,FoContext * context,GError ** error)176 fo_property_block_progression_dimension_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, "auto") == 0)
185 {
186 return g_object_ref (fo_length_range_new_auto ());
187 }
188 else
189 {
190 g_set_error (error,
191 FO_FO_ERROR,
192 FO_FO_ERROR_ENUMERATION_TOKEN,
193 _(fo_fo_error_messages[FO_FO_ERROR_ENUMERATION_TOKEN]),
194 class_name,
195 token);
196 return NULL;
197 }
198 }
199
200 /**
201 * fo_property_block_progression_dimension_validate:
202 * @datatype: #FoDatatype to be validated against allowed datatypes and
203 * values for current property.
204 * @context: #FoContext object from which to possibly inherit values.
205 * @error: Information about any error that has occurred.
206 *
207 * Validates @datatype against allowed values. Returns @datatype, a
208 * replacement datatype value, or NULL if validation failed.
209 *
210 * Return value: Valid datatype value or NULL.
211 **/
212 FoDatatype*
fo_property_block_progression_dimension_validate(FoDatatype * datatype,FoContext * context,GError ** error)213 fo_property_block_progression_dimension_validate (FoDatatype *datatype,
214 FoContext *context,
215 GError **error)
216 {
217 FoDatatype *new_datatype;
218 GError *tmp_error = NULL;
219 gchar *token;
220
221 g_return_val_if_fail (datatype != NULL, NULL);
222 g_return_val_if_fail (FO_IS_DATATYPE (datatype), NULL);
223 g_return_val_if_fail (context != NULL, NULL);
224 g_return_val_if_fail (FO_IS_CONTEXT (context), NULL);
225 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
226
227 if (FO_IS_ENUM (datatype))
228 {
229 FoEnumEnum value = fo_enum_get_value (datatype);
230
231 if ((value == FO_ENUM_ENUM_AUTO))
232 {
233 return datatype;
234 }
235 else
236 {
237 gchar *datatype_sprintf = fo_object_sprintf (datatype);
238
239 g_set_error (error,
240 FO_FO_ERROR,
241 FO_FO_ERROR_ENUMERATION_TOKEN,
242 _(fo_fo_error_messages[FO_FO_ERROR_ENUMERATION_TOKEN]),
243 class_name,
244 datatype_sprintf,
245 g_type_name (G_TYPE_FROM_INSTANCE (datatype)));
246
247 g_object_unref (datatype);
248
249 g_free (datatype_sprintf);
250
251 return NULL;
252 }
253 }
254 else if (FO_IS_STRING (datatype))
255 {
256 token = fo_string_get_value (datatype);
257
258 new_datatype =
259 fo_property_block_progression_dimension_resolve_enum (token, context, &tmp_error);
260
261 g_object_unref (datatype);
262
263 fo_propagate_and_return_val_if_error (error, tmp_error, NULL);
264
265 return new_datatype;
266 }
267 else if (FO_IS_NAME (datatype))
268 {
269 token = fo_name_get_value (datatype);
270
271 new_datatype =
272 fo_property_block_progression_dimension_resolve_enum (token, context, &tmp_error);
273
274 g_object_unref (datatype);
275
276 fo_propagate_and_return_val_if_error (error, tmp_error, NULL);
277
278 return new_datatype;
279 }
280 else if (FO_IS_LENGTH (datatype))
281 {
282 return datatype;
283 }
284 else if (FO_IS_PERCENTAGE (datatype))
285 {
286 return datatype;
287 }
288 else if (FO_IS_LENGTH_RANGE (datatype))
289 {
290 return datatype;
291 }
292 else
293 {
294 gchar *datatype_sprintf = fo_object_sprintf (datatype);
295
296 g_set_error (error,
297 FO_FO_ERROR,
298 FO_FO_ERROR_DATATYPE,
299 _(fo_fo_error_messages[FO_FO_ERROR_DATATYPE]),
300 class_name,
301 datatype_sprintf,
302 g_type_name (G_TYPE_FROM_INSTANCE (datatype)));
303
304 g_object_unref (datatype);
305
306 g_free (datatype_sprintf);
307
308 return NULL;
309 }
310 }
311
312 /**
313 * fo_property_block_progression_dimension_get_initial:
314 *
315 * Get an instance of the property with the correct initial value.
316 *
317 * Return value: An instance of the property.
318 **/
319 FoProperty*
fo_property_block_progression_dimension_get_initial(void)320 fo_property_block_progression_dimension_get_initial (void)
321 {
322 static FoProperty *block_progression_dimension = NULL;
323
324 if (block_progression_dimension == NULL)
325 {
326 block_progression_dimension =
327 fo_property_block_progression_dimension_new ();
328 }
329
330 return block_progression_dimension;
331 }
332