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