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