aboutsummaryrefslogblamecommitdiffstats
path: root/e-util/e-xml-utils.c
blob: 8a931d07f6dc86a24f11b710a1e8ccec1953541e (plain) (tree)





















                                                                           
                   
                              
                            
                 
                             
                                
                        
 

                                                                          

                       
 

                                                        
        

                                                                          




                                     
 




                                                                     
                                                                                                     




                                                        

                                                        
 






                                                                          
                                          
                                                                       
                                             
                         




                 




























































































                                                                                                                                   
 
                      
                           



                                                    


                                                          
                               

                       
 

    
                                                                                      
 
                        

                                          
                                             
 




                                                 










                                                                                                     

                      
                            



                                                    



                                                          



                       





















                                                                                    








                                                                                                       


                                                          
                                       
                                                             
                                        
                 




                              
    
                                                                                       



                                             
                    
                                                       
                
                                                        
         

 

                                                                               
 


                                                    
                                                                                   

 

                                                                                                         

                      
                              



                                                    


                                                          
                               



                       
    
                                                                                       
 
                        



                                             
                                                        
                                                         
                
                                                                    
         
                                                 
                          
 
 










                                                                                                              

                      
                       



                                                    

                                                          

                                          

                                         




                       
                                                                                             
 


                                             
                            
                                                      
         

 

                                                                                          

                      
                              
 

                                                    
 

                                                          




                                             
 
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-xml-utils.c
 * Copyright (C) 2000  Helix Code, Inc.
 * Author: Chris Lahey <clahey@helixcode.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 */

#include <locale.h>
#include <libgnome/libgnome.h>
#include "gal/util/e-i18n.h"
#include <math.h>
#include <gnome-xml/parser.h>
#include <gnome-xml/xmlmemory.h>
#include "e-xml-utils.h"

xmlNode *
e_xml_get_child_by_name (const xmlNode *parent, const xmlChar *child_name)
{
    xmlNode *child;

    g_return_val_if_fail (parent != NULL, NULL);
    g_return_val_if_fail (child_name != NULL, NULL);
    
    for (child = parent->childs; child != NULL; child = child->next) {
        if (xmlStrcmp (child->name, child_name) == 0) {
            return child;
        }
    }
    return NULL;
}

/* Returns the first child with the name child_name and the "lang"
 * attribute that matches the current LC_MESSAGES, or else, the first
 * child with the name child_name and no "lang" attribute.
 */
xmlNode *
e_xml_get_child_by_name_by_lang (const xmlNode *parent, const xmlChar *child_name, const gchar *lang)
{
    xmlNode *child;
    /* This is the default version of the string. */
    xmlNode *C = NULL;

    g_return_val_if_fail (parent != NULL, NULL);
    g_return_val_if_fail (child_name != NULL, NULL);

    if (lang == NULL) {
        lang = setlocale (LC_MESSAGES, NULL);
    }
    for (child = parent->childs; child != NULL; child = child->next) {
        if (xmlStrcmp (child->name, child_name) == 0) {
            xmlChar *this_lang = xmlGetProp (child, "lang");
            if (this_lang == NULL) {
                C = child;
            } else if (xmlStrcmp(this_lang, "lang") == 0) {
                return child;
            }
        }
    }
    return C;
}

static xmlNode *
e_xml_get_child_by_name_by_lang_list_with_score (const xmlNode *parent, const gchar *name, GList *lang_list, gint *best_lang_score)
{
    xmlNodePtr best_node = NULL, node;

    for (node = parent->childs; node != NULL; node = node->next) {
        xmlChar *lang;

        if (node->name == NULL || strcmp (node->name, name) != 0) {
            continue;
        }
        lang = xmlGetProp (node, "xml:lang");
        if (lang != NULL) {
            GList *l;
            gint i;

            for (l = lang_list, i = 0; l != NULL && i < *best_lang_score; l = l->next, i++) {
                if (strcmp ((gchar *) l->data, lang) == 0) {
                    best_node = node;
                    *best_lang_score = i;
                }
            }
        } else {
            if (best_node == NULL) {
                best_node = node;
            }
        }
        xmlFree (lang);
        if (*best_lang_score == 0) {
            return best_node;
        } 
    }

    return best_node;
}

/*
 * e_xml_get_child_by_name_by_lang_list:
 *
 */
xmlNode *
e_xml_get_child_by_name_by_lang_list (const xmlNode *parent, const gchar *name, GList *lang_list)
{
    gint best_lang_score = INT_MAX;

    g_return_val_if_fail (parent != NULL, NULL);
    g_return_val_if_fail (name != NULL, NULL);

    if (lang_list == NULL) {
        lang_list = gnome_i18n_get_language_list ("LC_MESSAGES");
    }
    return e_xml_get_child_by_name_by_lang_list_with_score (parent, name, lang_list, &best_lang_score);
}

/*
 * e_xml_get_child_by_name_no_lang
 *
 */
xmlNode *
e_xml_get_child_by_name_no_lang (const xmlNode *parent, const gchar *name)
{
    xmlNodePtr node;

    g_return_val_if_fail (parent != NULL, NULL);
    g_return_val_if_fail (name != NULL, NULL);

    for (node = parent->childs; node != NULL; node = node->next) {
        xmlChar *lang;

        if (node->name == NULL || strcmp (node->name, name) != 0) {
            continue;
        }
        lang = xmlGetProp (node, "xml:lang");
        if (lang == NULL) {
            return node;
        }
        xmlFree (lang);
    }

    return NULL;
}

gint
e_xml_get_integer_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_integer_prop_by_name_with_default (parent, prop_name, 0);
}

gint
e_xml_get_integer_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, gint def)
{
    xmlChar *prop;
    gint ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        (void) sscanf (prop, "%d", &ret_val);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_integer_prop_by_name (xmlNode *parent, const xmlChar *prop_name, gint value)
{
    gchar *valuestr;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    valuestr = g_strdup_printf ("%d", value);
    xmlSetProp (parent, prop_name, valuestr);
    g_free (valuestr);
}

guint
e_xml_get_uint_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_uint_prop_by_name_with_default (parent, prop_name, 0);
}

guint
e_xml_get_uint_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, guint def)
{
    xmlChar *prop;
    guint ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        (void) sscanf (prop, "%u", &ret_val);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_uint_prop_by_name (xmlNode *parent, const xmlChar *prop_name, guint value)
{
    gchar *valuestr;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    valuestr = g_strdup_printf ("%u", value);
    xmlSetProp (parent, prop_name, valuestr);
    g_free (valuestr);
}

gboolean
e_xml_get_bool_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_bool_prop_by_name_with_default (parent, prop_name, FALSE);
}

gboolean
e_xml_get_bool_prop_by_name_with_default(const xmlNode *parent, const xmlChar *prop_name, gboolean def)
{
    xmlChar *prop;
    gboolean ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        if (strcasecmp (prop, "true") == 0) {
            ret_val = TRUE;
        } else if (strcasecmp (prop, "false") == 0) {
            ret_val = FALSE;
        }
        xmlFree(prop);
    }
    return ret_val;
}

void
e_xml_set_bool_prop_by_name (xmlNode *parent, const xmlChar *prop_name, gboolean value)
{
    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (value) {
        xmlSetProp (parent, prop_name, "true");
    } else {
        xmlSetProp (parent, prop_name, "false");
    }
}

gdouble
e_xml_get_double_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_double_prop_by_name_with_default (parent, prop_name, 0.0);
}

gdouble
e_xml_get_double_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, gdouble def)
{
    xmlChar *prop;
    gdouble ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        (void) sscanf (prop, "%lf", &ret_val);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_double_prop_by_name(xmlNode *parent, const xmlChar *prop_name, gdouble value)
{
    gchar *valuestr;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (fabs (value) < 1e9 && fabs (value) > 1e-5) {
        valuestr = g_strdup_printf ("%f", value);
    } else {
        valuestr = g_strdup_printf ("%.*g", DBL_DIG, value);
    }
    xmlSetProp (parent, prop_name, valuestr);
    g_free (valuestr);
}

gchar *
e_xml_get_string_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_string_prop_by_name_with_default (parent, prop_name, NULL);
}

gchar *
e_xml_get_string_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, const gchar *def)
{
    xmlChar *prop;
    gchar *ret_val;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        ret_val = g_strdup (prop);
        xmlFree (prop);
    } else {
        ret_val = g_strdup (def);
    }
    return ret_val;
}

void
e_xml_set_string_prop_by_name (xmlNode *parent, const xmlChar *prop_name, const gchar *value)
{
    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (value != NULL) {
        xmlSetProp (parent, prop_name, value);
    }
}

gchar *
e_xml_get_translated_string_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    xmlChar *prop;
    gchar *ret_val = NULL;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        ret_val = g_strdup (_(prop));
        xmlFree (prop);
    }
    return ret_val;
}