/*
- * (LIBGLABELS) Template library for GLABELS
+ * xml.c
+ * Copyright (C) 2003-2009 Jim Evins <evins@snaught.com>.
*
- * xml.c: GLabels xml utilities module
+ * This file is part of libglabels.
*
- * Copyright (C) 2003, 2004 Jim Evins <evins@snaught.com>.
+ * libglabels is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
*
- * This file is part of the LIBGLABELS library.
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
+ * libglabels is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the Free
- * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- * MA 02111-1307, USA
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with libglabels. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "libglabels-private.h"
+#include <config.h>
#include "xml.h"
+#include <glib/gi18n.h>
+#include <glib.h>
+#include <string.h>
+
+#include "libglabels-private.h"
+
+
/*========================================================*/
/* Private macros and constants. */
/*========================================================*/
/*========================================================*/
typedef struct {
- gchar *name;
+ xmlChar *name;
gdouble points_per_unit;
} UnitTableEntry;
/* These names are identical to the absolute length units supported in
the CSS2 Specification (Section 4.3.2) */
- /* This table must be sorted exactly as the enumerations in glUnitsType */
+ /* This table must be sorted exactly as the enumerations in lglUnitsType */
- /* [GL_UNITS_POINT] */ {"pt", POINTS_PER_POINT},
- /* [GL_UNITS_INCH] */ {"in", POINTS_PER_INCH},
- /* [GL_UNITS_MM] */ {"mm", POINTS_PER_MM},
- /* [GL_UNITS_CM] */ {"cm", POINTS_PER_CM},
- /* [GL_UNITS_PICA] */ {"pc", POINTS_PER_PICA},
+ /* [LGL_UNITS_POINT] */ {(xmlChar *)"pt", POINTS_PER_POINT},
+ /* [LGL_UNITS_INCH] */ {(xmlChar *)"in", POINTS_PER_INCH},
+ /* [LGL_UNITS_MM] */ {(xmlChar *)"mm", POINTS_PER_MM},
+ /* [LGL_UNITS_CM] */ {(xmlChar *)"cm", POINTS_PER_CM},
+ /* [LGL_UNITS_PICA] */ {(xmlChar *)"pc", POINTS_PER_PICA},
};
-static glUnitsType default_units = GL_UNITS_POINT;
+static lglUnitsType default_units = LGL_UNITS_POINT;
-/*========================================================*/
-/* Private function prototypes. */
-/*========================================================*/
-\f
-/****************************************************************************/
-/* Return value of property as a double. */
/****************************************************************************/
+
+/**
+ * lgl_xml_get_prop_string:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as a string.
+ *
+ * Returns: the property as a pointer to a gchar string. This string should
+ * be freed with g_free().
+ *
+ */
+gchar *
+lgl_xml_get_prop_string (xmlNodePtr node,
+ const gchar *property,
+ const gchar *default_val)
+{
+ gchar *val;
+ xmlChar *string;
+
+ string = xmlGetProp (node, (xmlChar *)property);
+ if ( string != NULL ) {
+ val = g_strdup ((gchar *)string);
+ xmlFree (string);
+ return val;
+ }
+
+ if (default_val) {
+ return g_strdup (default_val);
+ }
+
+ return NULL;
+}
+
+
+/**
+ * lgl_xml_get_prop_i18n_string:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of a translatable property as a string.
+ *
+ * Returns: the property as a pointer to a gchar string. This string should
+ * be freed with g_free().
+ *
+ */
+gchar *
+lgl_xml_get_prop_i18n_string (xmlNodePtr node,
+ const gchar *property,
+ const gchar *default_val)
+{
+ gchar *_property;
+ gchar *val;
+ xmlChar *string;
+
+ _property = g_strdup_printf ("_%s", property);
+ string = xmlGetProp (node, (xmlChar *)_property);
+ g_free (_property);
+
+ if ( string != NULL ) {
+
+ val = g_strdup (gettext ((char *)string));
+ xmlFree (string);
+ return val;
+
+ }
+
+ string = xmlGetProp (node, (xmlChar *)property);
+ if ( string != NULL ) {
+ val = g_strdup ((gchar *)string);
+ xmlFree (string);
+ return val;
+ }
+
+ if (default_val) {
+ return g_strdup (default_val);
+ }
+
+ return NULL;
+}
+
+
+/**
+ * lgl_xml_get_prop_double:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as a double.
+ *
+ * Returns: the property as a double.
+ *
+ */
gdouble
-gl_xml_get_prop_double (xmlNodePtr node,
- const gchar *property,
- gdouble default_val)
+lgl_xml_get_prop_double (xmlNodePtr node,
+ const gchar *property,
+ gdouble default_val)
{
gdouble val;
- gchar *string;
+ xmlChar *string;
- string = xmlGetProp (node, property);
+ string = xmlGetProp (node, (xmlChar *)property);
if ( string != NULL ) {
- val = g_strtod (string, NULL);
- g_free (string);
+ val = g_strtod ((gchar *)string, NULL);
+ xmlFree (string);
return val;
}
return default_val;
}
-/****************************************************************************/
-/* Return value of property as a boolean. */
-/****************************************************************************/
+
+/**
+ * lgl_xml_get_prop_boolean:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as a boolean.
+ *
+ * Returns: the property as a boolean.
+ *
+ */
gboolean
-gl_xml_get_prop_boolean (xmlNodePtr node,
+lgl_xml_get_prop_boolean (xmlNodePtr node,
const gchar *property,
gboolean default_val)
{
gboolean val;
- gchar *string;
+ xmlChar *string;
- string = xmlGetProp (node, property);
+ string = xmlGetProp (node, (xmlChar *)property);
if ( string != NULL ) {
- val = !((xmlStrcasecmp (string, "false") == 0) ||
- xmlStrEqual (string, "0"));;
- g_free (string);
+ val = !((xmlStrcasecmp (string, (xmlChar *)"false") == 0) ||
+ xmlStrEqual (string, (xmlChar *)"0"));;
+ xmlFree (string);
return val;
}
}
-/****************************************************************************/
-/* Return value of property as an int. . */
-/****************************************************************************/
+/**
+ * lgl_xml_get_prop_int:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as an integer.
+ *
+ * Returns: the property as an integer.
+ *
+ */
gint
-gl_xml_get_prop_int (xmlNodePtr node,
- const gchar *property,
- gint default_val)
+lgl_xml_get_prop_int (xmlNodePtr node,
+ const gchar *property,
+ gint default_val)
{
gint val;
- gchar *string;
+ xmlChar *string;
- string = xmlGetProp (node, property);
+ string = xmlGetProp (node, (xmlChar *)property);
if ( string != NULL ) {
- val = strtol (string, NULL, 0);
- g_free (string);
+ val = strtol ((char *)string, NULL, 0);
+ xmlFree (string);
return val;
}
}
-/****************************************************************************/
-/* Return value of hex property as an unsigned int. */
-/****************************************************************************/
+/**
+ * lgl_xml_get_prop_uint:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property (usually formatted in hex) as an unsigned integer.
+ *
+ * Returns: the property as an unsigned integer.
+ *
+ */
guint
-gl_xml_get_prop_uint (xmlNodePtr node,
- const gchar *property,
- guint default_val)
+lgl_xml_get_prop_uint (xmlNodePtr node,
+ const gchar *property,
+ guint default_val)
{
guint val;
- gchar *string;
+ xmlChar *string;
- string = xmlGetProp (node, property);
+ string = xmlGetProp (node, (xmlChar *)property);
if ( string != NULL ) {
- val = strtoul (string, NULL, 0);
- g_free (string);
+ val = strtoul ((char *)string, NULL, 0);
+ xmlFree (string);
return val;
}
}
-/****************************************************************************/
-/* Return value of length property as a double, converting to internal units*/
-/****************************************************************************/
+/**
+ * lgl_xml_get_prop_length:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of a length property as a double, converting to internal
+ * units (points). The property is expected to be formatted as a number
+ * followed by a units string. If there is no units string, the length
+ * is assumed to be in points. Valid units strings are "pt" for points,
+ * "in" for inches, "mm" for millimeters, "cm" for centimeters, and
+ * "pc" for picas.
+ *
+ * Returns: the length in points.
+ *
+ */
gdouble
-gl_xml_get_prop_length (xmlNodePtr node,
- const gchar *property,
- gdouble default_val)
+lgl_xml_get_prop_length (xmlNodePtr node,
+ const gchar *property,
+ gdouble default_val)
{
gdouble val;
- gchar *string, *unit;
+ xmlChar *string;
+ xmlChar *unit;
gint i;
- string = xmlGetProp (node, property);
+ string = xmlGetProp (node, (xmlChar *)property);
if ( string != NULL ) {
- val = g_strtod (string, &unit);
+ val = g_strtod ((gchar *)string, (gchar **)&unit);
if (unit != string) {
- unit = g_strchug (unit);
- if (strlen (unit) > 0 ) {
- for (i=GL_UNITS_FIRST; i<=GL_UNITS_LAST; i++) {
+ unit = (xmlChar *)g_strchug ((gchar *)unit);
+ if (strlen ((char *)unit) > 0 ) {
+ for (i=LGL_UNITS_FIRST; i<=LGL_UNITS_LAST; i++) {
if (xmlStrcasecmp (unit, unit_table[i].name) == 0) {
val *= unit_table[i].points_per_unit;
break;
}
}
- if (i>GL_UNITS_LAST) {
- g_warning ("Line %d, Node \"%s\", Property \"%s\": Unknown unit \"%s\", assuming points",
+ if (i>LGL_UNITS_LAST) {
+ g_message ("Line %ld, Node \"%s\", Property \"%s\": Unknown unit \"%s\", assuming points",
xmlGetLineNo (node), node->name, property,
unit);
}
val = 0.0;
}
- g_free (string);
+ xmlFree (string);
return val;
}
return default_val;
}
-/****************************************************************************/
-/* Set property from double. */
-/****************************************************************************/
+
+/**
+ * lgl_xml_set_prop_string:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from a string.
+ *
+ */
void
-gl_xml_set_prop_double (xmlNodePtr node,
- const gchar *property,
- gdouble val)
+lgl_xml_set_prop_string (xmlNodePtr node,
+ const gchar *property,
+ const gchar *val)
+{
+ if (val != NULL) {
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)val);
+ }
+}
+
+
+/**
+ * lgl_xml_set_prop_double:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from a double.
+ *
+ */
+void
+lgl_xml_set_prop_double (xmlNodePtr node,
+ const gchar *property,
+ gdouble val)
{
gchar *string, buffer[G_ASCII_DTOSTR_BUF_SIZE];
/* Guarantee "C" locale by use of g_ascii_formatd */
string = g_ascii_formatd (buffer, G_ASCII_DTOSTR_BUF_SIZE, "%g", val);
- xmlSetProp (node, property, string);
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)string);
}
-/****************************************************************************/
-/* Set property from boolean. */
-/****************************************************************************/
+
+/**
+ * lgl_xml_set_prop_boolean:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from a boolean.
+ *
+ */
void
-gl_xml_set_prop_boolean (xmlNodePtr node,
- const gchar *property,
- gboolean val)
+lgl_xml_set_prop_boolean (xmlNodePtr node,
+ const gchar *property,
+ gboolean val)
{
- xmlSetProp (node, property, (val ? "True" : "False"));
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)(val ? "True" : "False"));
}
-/****************************************************************************/
-/* Set property from int. */
-/****************************************************************************/
+/**
+ * lgl_xml_set_prop_int:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from an integer.
+ *
+ */
void
-gl_xml_set_prop_int (xmlNodePtr node,
- const gchar *property,
- gint val)
+lgl_xml_set_prop_int (xmlNodePtr node,
+ const gchar *property,
+ gint val)
{
gchar *string;
string = g_strdup_printf ("%d", val);
- xmlSetProp (node, property, string);
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)string);
g_free (string);
}
-/****************************************************************************/
-/* Set property from uint in hex. */
-/****************************************************************************/
+/**
+ * lgl_xml_set_prop_uint_hex:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from an unsigned integer and format in hex.
+ *
+ */
void
-gl_xml_set_prop_uint_hex (xmlNodePtr node,
- const gchar *property,
- guint val)
+lgl_xml_set_prop_uint_hex (xmlNodePtr node,
+ const gchar *property,
+ guint val)
{
gchar *string;
string = g_strdup_printf ("0x%08x", val);
- xmlSetProp (node, property, string);
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)string);
g_free (string);
}
-/****************************************************************************/
-/* Set property from length. */
-/****************************************************************************/
+/**
+ * lgl_xml_set_prop_length:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the length to set in internal units (points)
+ *
+ * Set a property from a length, performing any necessary conversion.
+ * Length properties are formatted as a number followed by a units string.
+ * The units of the formatted property is determined by the most recent call to
+ * lgl_xml_set_default_units().
+ *
+ */
void
-gl_xml_set_prop_length (xmlNodePtr node,
- const gchar *property,
- gdouble val)
+lgl_xml_set_prop_length (xmlNodePtr node,
+ const gchar *property,
+ gdouble val)
{
gchar *string, buffer[G_ASCII_DTOSTR_BUF_SIZE];
gchar *string_unit;
string = g_ascii_formatd (buffer, G_ASCII_DTOSTR_BUF_SIZE, "%g", val);
string_unit = g_strdup_printf ("%s%s", string, unit_table[default_units].name);
- xmlSetProp (node, property, string_unit);
+ xmlSetProp (node, (xmlChar *)property, (xmlChar *)string_unit);
g_free (string_unit);
}
-/****************************************************************************/
-/* Set default length units. */
-/****************************************************************************/
+/**
+ * lgl_xml_is_node
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @name : the node name
+ *
+ * Test if a node name matches given name.
+ *
+ * Returns: TRUE if the name of the node matches. Otherwise FALSE.
+ *
+ */
+gboolean
+lgl_xml_is_node (xmlNodePtr node,
+ const gchar *name)
+{
+ return xmlStrEqual (node->name, (xmlChar *)name);
+}
+
+
+/**
+ * lgl_xml_get_node_content
+ * @node: the libxml2 #xmlNodePtr of the node
+ *
+ * Get the content of a node.
+ *
+ * Returns: the property as a pointer to a gchar string. This string should
+ * be freed with g_free().
+ */
+gchar *
+lgl_xml_get_node_content (xmlNodePtr node)
+{
+ xmlChar *xml_content;
+ gchar *g_content;
+
+ xml_content = xmlNodeGetContent (node);
+
+ if (xml_content != NULL) {
+
+ g_content = g_strdup ((gchar *)xml_content);
+ xmlFree (xml_content);
+ return g_content;
+
+ }
+
+ return NULL;
+}
+
+
+/**
+ * lgl_xml_set_default_units:
+ * @units: default units selection (#lglUnitsType)
+ *
+ * Set the default units when formatting lengths. See
+ * lgl_xml_set_prop_length().
+ *
+ */
void
-gl_xml_set_default_units (glUnitsType units)
+lgl_xml_set_default_units (lglUnitsType units)
{
- g_return_if_fail ((units >= GL_UNITS_FIRST) && (units <= GL_UNITS_LAST));
+ g_return_if_fail ((units >= LGL_UNITS_FIRST) && (units <= LGL_UNITS_LAST));
default_units = units;
}
+
+/*
+ * Local Variables: -- emacs
+ * mode: C -- emacs
+ * c-basic-offset: 8 -- emacs
+ * tab-width: 8 -- emacs
+ * indent-tabs-mode: nil -- emacs
+ * End: -- emacs
+ */
projects / glabels / blobdiff