path: root/lib/ephy-string.c

/*
 *  Copyright © 2002 Marco Pesenti Gritti
 *
 *  This program 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, 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 program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  $Id$
 */

#include "config.h"

#include "ephy-string.h"

#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <glib.h>

#define ELLIPSIS "\xe2\x80\xa6"

gboolean
ephy_string_to_int (const char *string, gulong *integer)
{
    gulong result;
    char *parse_end;

    /* Check for the case of an empty string. */
    if (string == NULL || *string == '\0')
    {
        return FALSE;
    }

    /* Call the standard library routine to do the conversion. */
    errno = 0;
    result = strtol (string, &parse_end, 0);

    /* Check that the result is in range. */
    if ((result == G_MINLONG || result == G_MAXLONG) && errno == ERANGE)
    {
        return FALSE;
    }

    /* Check that all the trailing characters are spaces. */
    while (*parse_end != '\0')
    {
        if (!g_ascii_isspace (*parse_end++))
        {
            return FALSE;
        }
    }

    /* Return the result. */
    *integer = result;
    return TRUE;
}

char *
ephy_string_blank_chr (char *source)
{
    char *p;

        if (source == NULL)
    {
        return NULL;
    }

    p = source;
    while (*p != '\0')
    {
        if ((guchar) *p < 0x20)
        {
            *p = ' ';
        }
        p++;
    }

        return source;
}

/**
 * ephy_string_shorten: shortens a string
 * @str: the string to shorten, in UTF-8
 * @target_length: the length of the shortened string (in characters)
 * 
 * If @str is already short enough, it is returned. Otherwise a new string
 * is allocated and @str is consumed.
 * 
 * Return value: a newly allocated string, not longer than target_length
 * characters.
 */
char *
ephy_string_shorten (char *str,
             gsize target_length)
{
        char *new_str;
        glong actual_length;
        gulong bytes;

    g_return_val_if_fail (target_length > 0, NULL);

        if (!str) return NULL;

    /* FIXME: this function is a big mess. While it is utf-8 safe now,
     * it can still split a sequence of combining characters.
     */

        actual_length = g_utf8_strlen (str, -1);

        /* if the string is already short enough, or if it's too short for
         * us to shorten it, return a new copy */
        if (actual_length <= target_length) return str;

        /* create string */
        bytes = GPOINTER_TO_UINT (g_utf8_offset_to_pointer (str, target_length - 1) - str);

        new_str = g_new (gchar, bytes + strlen(ELLIPSIS) + 1);

        strncpy (new_str, str, bytes);
        strncpy (new_str + bytes, ELLIPSIS, strlen (ELLIPSIS));
    new_str[bytes + strlen (ELLIPSIS)] = '\0';

    g_free (str);

        return new_str;
}

/* This is a collation key that is very very likely to sort before any
   collation key that libc strxfrm generates. We use this before any
   special case (dot or number) to make sure that its sorted before
   anything else.
 */
#define COLLATION_SENTINEL "\1\1\1"

/**
 * ephy_string_collate_key_for_domain:
 * @host:
 * @len: the length of @host, or -1 to use the entire null-terminated @host string
 * 
 * Return value: a collation key for @host.
 */
char*
ephy_string_collate_key_for_domain (const char *str,
                    gssize len)
{
    GString *result;
    const char *dot;
    gssize newlen;

    if (len < 0) len = strlen (str);

    result = g_string_sized_new (len + 6 * strlen (COLLATION_SENTINEL));

    /* Note that we could do even better by using
     * g_utf8_collate_key_for_filename on the dot-separated
     * components, but this seems good enough for now.
     */
    while ((dot = g_strrstr_len (str, len, ".")) != NULL)
    {
        newlen = dot - str;

        g_string_append_len (result, dot + 1, len - newlen - 1);
        g_string_append (result, COLLATION_SENTINEL);

        len = newlen;
    }

    if (len > 0)
    {
        g_string_append_len (result, str, len);
    }

    return g_string_free (result, FALSE);
}

guint
ephy_string_flags_from_string (GType type,
                   const char *flags_string)
{
    GFlagsClass *flags_class;
    const GFlagsValue *value;
    gchar **flags;
    guint retval = 0, i;

    g_return_val_if_fail (flags_string != NULL, 0);

    flags = g_strsplit (flags_string, "|", -1);
    if (!flags) return 0;

    flags_class = g_type_class_ref (type);

    for (i = 0; flags[i] != NULL; ++i)
    {
        value = g_flags_get_value_by_nick (flags_class, flags[i]);
        if (value != NULL)
        {
            retval |= value->value;
        }
    }

    g_type_class_unref (flags_class);

    return retval;
}

char *
ephy_string_flags_to_string (GType type,
                 guint flags_value)
{
    GFlagsClass *flags_class;
    GString *string;
    gboolean first = TRUE;
    guint i;

    string = g_string_sized_new (128);

    flags_class = g_type_class_ref (type);

    for (i = 0; i < flags_class->n_values; ++i)
    {
        if (flags_value & flags_class->values[i].value)
        {
            if (!first)
            {
                g_string_append_c (string, '|');
            }
            first = FALSE;
            g_string_append (string, flags_class->values[i].value_nick);
        }
    }

    g_type_class_unref (flags_class);

    return g_string_free (string, FALSE);
}

guint
ephy_string_enum_from_string (GType type,
                  const char *enum_string)
{
    GEnumClass *enum_class;
    const GEnumValue *value;
    guint retval = 0;

    g_return_val_if_fail (enum_string != NULL, 0);

    enum_class = g_type_class_ref (type);
    value = g_enum_get_value_by_nick (enum_class, enum_string);
    if (value != NULL)
    {
        retval = value->value;
    }

    g_type_class_unref (enum_class);

    return retval;
}

char *
ephy_string_enum_to_string (GType type,
                guint enum_value)
{
    GEnumClass *enum_class;
    GEnumValue *value;
    char *retval = NULL;

    enum_class = g_type_class_ref (type);

    value = g_enum_get_value (enum_class, enum_value);
    if (value)
    {
        retval = g_strdup (value->value_nick);
    }

    g_type_class_unref (enum_class);

    return retval;
}