Add API docs for keybinding enums.

[geany-mirror.git] / src / utils.c

/*
 *      utils.c - this file is part of Geany, a fast and lightweight IDE
 *
 *      Copyright 2005-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
 *      Copyright 2006-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
 *
 *      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 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 program; if not, write to the Free Software
 *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $Id$
 */

/*
 * General utility functions, non-GTK related.
 */

#include "geany.h"

#include <stdlib.h>
#include <ctype.h>
#include <math.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <stdarg.h>

#ifdef HAVE_SYS_STAT_H
# include <sys/stat.h>
#endif
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif

#include <glib/gstdio.h>

#ifdef HAVE_GIO
# include <gio/gio.h>
#endif

#include "prefs.h"
#include "support.h"
#include "document.h"
#include "filetypes.h"
#include "dialogs.h"
#include "win32.h"
#include "project.h"

#include "utils.h"


/**
 *  Tries to open the given URI in a browser.
 *  On Windows, the system's default browser is opened.
 *  On non-Windows systems, the browser command set in the preferences dialog is used. In case
 *  that fails or it is unset, @c xdg-open is used as fallback as well as some other known
 *  browsers.
 *
 *  @param uri The URI to open in the web browser.
 *
 *  @since 0.16
 **/
void utils_open_browser(const gchar *uri)
{
#ifdef G_OS_WIN32
        g_return_if_fail(uri != NULL);
        win32_open_browser(uri);
#else
        gchar *cmdline;

        g_return_if_fail(uri != NULL);

        cmdline = g_strconcat(tool_prefs.browser_cmd, " \"", uri, "\"", NULL);
        if (! g_spawn_command_line_async(cmdline, NULL))
        {
                const gchar *argv[3];

                argv[0] = "xdg-open";
                argv[1] = uri;
                argv[2] = NULL;
                if (! g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH,
                                NULL, NULL, NULL, NULL))
                {
                        argv[0] = "firefox";
                        if (! g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH,
                                        NULL, NULL, NULL, NULL))
                        {
                                argv[0] = "mozilla";
                                if (! g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH, NULL,
                                                NULL, NULL, NULL))
                                {
                                        argv[0] = "opera";
                                        if (! g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH,
                                                        NULL, NULL, NULL, NULL))
                                        {
                                                argv[0] = "konqueror";
                                                if (! g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH,
                                                                NULL, NULL, NULL, NULL))
                                                {
                                                        argv[0] = "netscape";
                                                        g_spawn_async(NULL, (gchar**)argv, NULL, G_SPAWN_SEARCH_PATH,
                                                                NULL, NULL, NULL, NULL);
                                                }
                                        }
                                }
                        }
                }
        }
        g_free(cmdline);
#endif
}


/* taken from anjuta, to determine the EOL mode of the file */
gint utils_get_line_endings(const gchar* buffer, glong size)
{
        gint i;
        guint cr, lf, crlf, max_mode;
        gint mode;

        cr = lf = crlf = 0;

        for (i = 0; i < size ; i++)
        {
                if (buffer[i] == 0x0a)
                {
                        /* LF */
                        lf++;
                }
                else if (buffer[i] == 0x0d)
                {
                        if (i >= (size - 1))
                        {
                                /* Last char, CR */
                                cr++;
                        }
                        else
                        {
                                if (buffer[i + 1] != 0x0a)
                                {
                                        /* CR */
                                        cr++;
                                }
                                else
                                {
                                        /* CRLF */
                                        crlf++;
                                }
                                i++;
                        }
                }
        }

        /* Vote for the maximum */
        mode = SC_EOL_LF;
        max_mode = lf;
        if (crlf > max_mode)
        {
                mode = SC_EOL_CRLF;
                max_mode = crlf;
        }
        if (cr > max_mode)
        {
                mode = SC_EOL_CR;
                max_mode = cr;
        }

        return mode;
}


gboolean utils_isbrace(gchar c, gboolean include_angles)
{
        switch (c)
        {
                case '<':
                case '>':
                return include_angles;

                case '(':
                case ')':
                case '{':
                case '}':
                case '[':
                case ']': return TRUE;
                default:  return FALSE;
        }
}


gboolean utils_is_opening_brace(gchar c, gboolean include_angles)
{
        switch (c)
        {
                case '<':
                return include_angles;

                case '(':
                case '{':
                case '[':  return TRUE;
                default:  return FALSE;
        }
}


/**
 *  Writes the given @a text into a file with @a filename.
 *  If the file doesn't exist, it will be created.
 *  If it already exists, it will be overwritten.
 *
 *  @param filename The filename of the file to write, in locale encoding.
 *  @param text The text to write into the file.
 *
 *  @return 0 if the file was successfully written, otherwise the @c errno of the
 *          failed operation is returned.
 **/
gint utils_write_file(const gchar *filename, const gchar *text)
{
        g_return_val_if_fail(filename != NULL, ENOENT);
        g_return_val_if_fail(text != NULL, EINVAL);

        if (file_prefs.use_safe_file_saving)
        {
                GError *error = NULL;
                if (! g_file_set_contents(filename, text, -1, &error))
                {
                        geany_debug("%s: could not write to file %s (%s)", G_STRFUNC, filename, error->message);
                        g_error_free(error);
                        return EIO;
                }
        }
        else
        {
                FILE *fp;
                gint bytes_written, len;

                if (filename == NULL)
                        return ENOENT;

                len = strlen(text);
                fp = g_fopen(filename, "w");
                if (fp != NULL)
                {
                        bytes_written = fwrite(text, sizeof (gchar), len, fp);
                        fclose(fp);

                        if (len != bytes_written)
                        {
                                geany_debug(
                                        "utils_write_file(): written only %d bytes, had to write %d bytes to %s",
                                        bytes_written, len, filename);
                                return EIO;
                        }
                }
                else
                {
                        geany_debug("utils_write_file(): could not write to file %s (%s)",
                                filename, g_strerror(errno));
                        return errno;
                }
        }
        return 0;
}


/*
 * (stolen from anjuta and modified)
 * Search backward through size bytes looking for a '<', then return the tag, if any.
 * @return The tag name
 */
gchar *utils_find_open_xml_tag(const gchar sel[], gint size, gboolean check_tag)
{
        const gchar *begin, *cur;

        if (G_UNLIKELY(size < 3))
        {       /* Smallest tag is "<p>" which is 3 characters */
                return NULL;
        }
        begin = &sel[0];
        if (check_tag)
                cur = &sel[size - 3];
        else
                cur = &sel[size - 1];

        cur--; /* Skip past the > */
        while (cur > begin)
        {
                if (*cur == '<') break;
                else if (! check_tag && *cur == '>') break;
                --cur;
        }

        if (*cur == '<')
        {
                GString *result = g_string_sized_new(64);

                cur++;
                while (strchr(":_-.", *cur) || isalnum(*cur))
                {
                        g_string_append_c(result, *cur);
                        cur++;
                }
                return g_string_free(result, FALSE);
        }

        return NULL;
}


const gchar *utils_get_eol_name(gint eol_mode)
{
        switch (eol_mode)
        {
                case SC_EOL_CRLF: return _("Win (CRLF)"); break;
                case SC_EOL_CR: return _("Mac (CR)"); break;
                default: return _("Unix (LF)"); break;
        }
}


gboolean utils_atob(const gchar *str)
{
        if (G_UNLIKELY(str == NULL))
                return FALSE;
        else if (strcmp(str, "TRUE") == 0 || strcmp(str, "true") == 0)
                return TRUE;
        return FALSE;
}


/* NULL-safe version of g_path_is_absolute(). */
gboolean utils_is_absolute_path(const gchar *path)
{
        if (! NZV(path))
                return FALSE;

        return g_path_is_absolute(path);
}


/* Skips root if path is absolute, do nothing otherwise.
 * This is a relative-safe version of g_path_skip_root().
 */
const gchar *utils_path_skip_root(const gchar *path)
{
        const gchar *path_relative;

        path_relative = g_path_skip_root(path);

        return (path_relative != NULL) ? path_relative : path;
}


gdouble utils_scale_round(gdouble val, gdouble factor)
{
        /*val = floor(val * factor + 0.5);*/
        val = floor(val);
        val = MAX(val, 0);
        val = MIN(val, factor);

        return val;
}


/**
 *  A replacement function for g_strncasecmp() to compare strings case-insensitive.
 *  It converts both strings into lowercase using g_utf8_strdown() and then compare
 *  both strings using strcmp().
 *  This is not completely accurate regarding locale-specific case sorting rules
 *  but seems to be a good compromise between correctness and performance.
 *
 *  The input strings should be in UTF-8 or locale encoding.
 *
 *  @param s1 Pointer to first string or @c NULL.
 *  @param s2 Pointer to second string or @c NULL.
 *
 *  @return an integer less than, equal to, or greater than zero if @a s1 is found, respectively,
 *          to be less than, to match, or to be greater than @a s2.
 *
 *  @since 0.16
 */
gint utils_str_casecmp(const gchar *s1, const gchar *s2)
{
        gchar *tmp1, *tmp2;
        gint result;

        g_return_val_if_fail(s1 != NULL, 1);
        g_return_val_if_fail(s2 != NULL, -1);

        tmp1 = g_strdup(s1);
        tmp2 = g_strdup(s2);

        /* first ensure strings are UTF-8 */
        if (! g_utf8_validate(s1, -1, NULL))
                setptr(tmp1, g_locale_to_utf8(s1, -1, NULL, NULL, NULL));
        if (! g_utf8_validate(s2, -1, NULL))
                setptr(tmp2, g_locale_to_utf8(s2, -1, NULL, NULL, NULL));

        if (tmp1 == NULL)
        {
                g_free(tmp2);
                return 1;
        }
        if (tmp2 == NULL)
        {
                g_free(tmp1);
                return -1;
        }

        /* then convert the strings into a case-insensitive form */
        setptr(tmp1, g_utf8_strdown(tmp1, -1));
        setptr(tmp2, g_utf8_strdown(tmp2, -1));

        /* compare */
        result = strcmp(tmp1, tmp2);

        g_free(tmp1);
        g_free(tmp2);
        return result;
}


/**
 *  Truncates the input string to a given length.
 *  Characters are removed from the middle of the string, so the start and the end of string
 *  won't change.
 *
 *  @param string Input string.
 *  @param truncate_length The length in characters of the resulting string.
 *
 *  @return A copy of @a string which is truncated to @a truncate_length characters,
 *          should be freed when no longer needed.
 *
 *  @since 0.17
 */
/* This following function is taken from Gedit. */
gchar *utils_str_middle_truncate(const gchar *string, guint truncate_length)
{
        GString *truncated;
        guint length;
        guint n_chars;
        guint num_left_chars;
        guint right_offset;
        guint delimiter_length;
        const gchar *delimiter = "\342\200\246";

        g_return_val_if_fail(string != NULL, NULL);

        length = strlen(string);

        g_return_val_if_fail(g_utf8_validate(string, length, NULL), NULL);

        /* It doesnt make sense to truncate strings to less than the size of the delimiter plus 2
         * characters (one on each side) */
        delimiter_length = g_utf8_strlen(delimiter, -1);
        if (truncate_length < (delimiter_length + 2))
                return g_strdup(string);

        n_chars = g_utf8_strlen(string, length);

        /* Make sure the string is not already small enough. */
        if (n_chars <= truncate_length)
                return g_strdup (string);

        /* Find the 'middle' where the truncation will occur. */
        num_left_chars = (truncate_length - delimiter_length) / 2;
        right_offset = n_chars - truncate_length + num_left_chars + delimiter_length;

        truncated = g_string_new_len(string, g_utf8_offset_to_pointer(string, num_left_chars) - string);
        g_string_append(truncated, delimiter);
        g_string_append(truncated, g_utf8_offset_to_pointer(string, right_offset));

        return g_string_free(truncated, FALSE);
}


/**
 *  @c NULL-safe string comparison. Returns @c TRUE if both @a a and @a b are @c NULL
 *  or if @a a and @a b refer to valid strings which are equal.
 *
 *  @param a Pointer to first string or @c NULL.
 *  @param b Pointer to second string or @c NULL.
 *
 *  @return @c TRUE if @a a equals @a b, else @c FALSE.
 **/
gboolean utils_str_equal(const gchar *a, const gchar *b)
{
        /* (taken from libexo from os-cillation) */
        if (a == NULL && b == NULL) return TRUE;
        else if (a == NULL || b == NULL) return FALSE;

        while (*a == *b++)
                if (*a++ == '\0')
                        return TRUE;

        return FALSE;
}


/**
 *  Removes the extension from @a filename and return the result in a newly allocated string.
 *
 *  @param filename The filename to operate on.
 *
 *  @return A newly-allocated string, should be freed when no longer needed.
 **/
gchar *utils_remove_ext_from_filename(const gchar *filename)
{
        gchar *last_dot;
        gchar *result;
        gint i;

        g_return_val_if_fail(filename != NULL, NULL);

        last_dot = strrchr(filename, '.');
        if (! last_dot)
                return g_strdup(filename);

        /* assumes extension is small, so extra bytes don't matter */
        result = g_malloc(strlen(filename));
        i = 0;
        while ((filename + i) != last_dot)
        {
                result[i] = filename[i];
                i++;
        }
        result[i] = 0;
        return result;
}


gchar utils_brace_opposite(gchar ch)
{
        switch (ch)
        {
                case '(': return ')';
                case ')': return '(';
                case '[': return ']';
                case ']': return '[';
                case '{': return '}';
                case '}': return '{';
                case '<': return '>';
                case '>': return '<';
                default: return '\0';
        }
}


gchar *utils_get_hostname(void)
{
#ifdef G_OS_WIN32
        return win32_get_hostname();
#elif defined(HAVE_GETHOSTNAME)
        gchar hostname[100];
        if (gethostname(hostname, sizeof(hostname)) == 0)
                return g_strdup(hostname);
#endif
        return g_strdup("localhost");
}


/* Checks whether the given file can be written. locale_filename is expected in locale encoding.
 * Returns 0 if it can be written, otherwise it returns errno */
gint utils_is_file_writeable(const gchar *locale_filename)
{
        gchar *file;
        gint ret;

        if (! g_file_test(locale_filename, G_FILE_TEST_EXISTS) &&
                ! g_file_test(locale_filename, G_FILE_TEST_IS_DIR))
                /* get the file's directory to check for write permission if it doesn't yet exist */
                file = g_path_get_dirname(locale_filename);
        else
                file = g_strdup(locale_filename);

#ifdef G_OS_WIN32
        /* use _waccess on Windows, access() doesn't accept special characters */
        ret = win32_check_write_permission(file);
#else

        /* access set also errno to "FILE NOT FOUND" even if locale_filename is writeable, so use
         * errno only when access() explicitly returns an error */
        if (access(file, R_OK | W_OK) != 0)
                ret = errno;
        else
                ret = 0;
#endif
        g_free(file);
        return ret;
}


/* Replaces all occurrences of needle in haystack with replacement.
 * Warning: *haystack must be a heap address; it may be freed and reassigned.
 * Note: utils_string_replace_all() will always be faster when @a replacement is longer
 * than @a needle.
 * All strings have to be NULL-terminated.
 * See utils_string_replace_all() for details. */
void utils_str_replace_all(gchar **haystack, const gchar *needle, const gchar *replacement)
{
        GString *str;

        g_return_if_fail(*haystack != NULL);

        str = g_string_new(*haystack);

        g_free(*haystack);
        utils_string_replace_all(str, needle, replacement);

        *haystack = g_string_free(str, FALSE);
}


gint utils_strpos(const gchar *haystack, const gchar *needle)
{
        gint haystack_length = strlen(haystack);
        gint needle_length = strlen(needle);
        gint i, j, pos = -1;

        if (needle_length > haystack_length)
        {
                return -1;
        }
        else
        {
                for (i = 0; (i < haystack_length) && pos == -1; i++)
                {
                        if (haystack[i] == needle[0] && needle_length == 1)
                                return i;
                        else if (haystack[i] == needle[0])
                        {
                                for (j = 1; (j < needle_length); j++)
                                {
                                        if (haystack[i + j] == needle[j])
                                        {
                                                if (pos == -1)
                                                        pos = i;
                                        }
                                        else
                                        {
                                                pos = -1;
                                                break;
                                        }
                                }
                        }
                }
                return pos;
        }
}


/**
 *  Retrieves a formatted date/time string from strftime().
 *  This function should be preferred to directly calling strftime() since this function
 *  works on UTF-8 encoded strings.
 *
 *  @param format The format string to pass to strftime(3). See the strftime(3)
 *                documentation for details, in UTF-8 encoding.
 *  @param time_to_use The date/time to use, in time_t format or NULL to use the current time.
 *
 *  @return A newly-allocated string, should be freed when no longer needed.
 *
 *  @since 0.16
 */
gchar *utils_get_date_time(const gchar *format, time_t *time_to_use)
{
        const struct tm *tm;
        static gchar date[1024];
        gchar *locale_format;
        gsize len;

        g_return_val_if_fail(format != NULL, NULL);

        if (! g_utf8_validate(format, -1, NULL))
        {
                locale_format = g_locale_from_utf8(format, -1, NULL, NULL, NULL);
                if (locale_format == NULL)
                        return NULL;
        }
        else
                locale_format = g_strdup(format);

        if (time_to_use != NULL)
                tm = localtime(time_to_use);
        else
        {
                time_t tp = time(NULL);
                tm = localtime(&tp);
        }

        len = strftime(date, 1024, locale_format, tm);
        g_free(locale_format);
        if (len == 0)
                return NULL;

        if (! g_utf8_validate(date, len, NULL))
                return g_locale_to_utf8(date, len, NULL, NULL, NULL);
        else
                return g_strdup(date);
}


gchar *utils_get_initials(const gchar *name)
{
        gint i = 1, j = 1;
        gchar *initials = g_malloc0(5);

        initials[0] = name[0];
        while (name[i] != '\0' && j < 4)
        {
                if (name[i] == ' ' && name[i + 1] != ' ')
                {
                        initials[j++] = name[i + 1];
                }
                i++;
        }
        return initials;
}


/**
 *  Wraps g_key_file_get_integer() to add a default value argument.
 *
 *  @param config A GKeyFile object.
 *  @param section The group name to look in for the key.
 *  @param key The key to find.
 *  @param default_value The default value which will be returned when @a section or @a key
 *         don't exist.
 *
 *  @return The value associated with @a key as an integer, or the given default value if the value
 *          could not be retrieved.
 **/
gint utils_get_setting_integer(GKeyFile *config, const gchar *section, const gchar *key,
                                                           const gint default_value)
{
        gint tmp;
        GError *error = NULL;

        if (G_UNLIKELY(config == NULL))
                return default_value;

        tmp = g_key_file_get_integer(config, section, key, &error);
        if (G_UNLIKELY(error))
        {
                g_error_free(error);
                return default_value;
        }
        return tmp;
}


/**
 *  Wraps g_key_file_get_boolean() to add a default value argument.
 *
 *  @param config A GKeyFile object.
 *  @param section The group name to look in for the key.
 *  @param key The key to find.
 *  @param default_value The default value which will be returned when @c section or @c key
 *         don't exist.
 *
 *  @return The value associated with @a key as a boolean, or the given default value if the value
 *          could not be retrieved.
 **/
gboolean utils_get_setting_boolean(GKeyFile *config, const gchar *section, const gchar *key,
                                                                   const gboolean default_value)
{
        gboolean tmp;
        GError *error = NULL;

        if (G_UNLIKELY(config == NULL))
                return default_value;

        tmp = g_key_file_get_boolean(config, section, key, &error);
        if (G_UNLIKELY(error))
        {
                g_error_free(error);
                return default_value;
        }
        return tmp;
}


/**
 *  Wraps g_key_file_get_string() to add a default value argument.
 *
 *  @param config A GKeyFile object.
 *  @param section The group name to look in for the key.
 *  @param key The key to find.
 *  @param default_value The default value which will be returned when @a section or @a key
 *         don't exist.
 *
 *  @return A newly allocated string, either the value for @a key or a copy of the given
 *          default value if it could not be retrieved.
 **/
gchar *utils_get_setting_string(GKeyFile *config, const gchar *section, const gchar *key,
                                                                const gchar *default_value)
{
        gchar *tmp;

        if (G_UNLIKELY(config == NULL))
                return g_strdup(default_value);

        tmp = g_key_file_get_string(config, section, key, NULL);
        if (G_UNLIKELY(!tmp))
        {
                return g_strdup(default_value);
        }
        return tmp;
}


gchar *utils_get_hex_from_color(GdkColor *color)
{
        gchar *buffer = g_malloc0(9);

        g_return_val_if_fail(color != NULL, NULL);

        g_snprintf(buffer, 8, "#%02X%02X%02X",
              (guint) (utils_scale_round(color->red / 256, 255)),
              (guint) (utils_scale_round(color->green / 256, 255)),
              (guint) (utils_scale_round(color->blue / 256, 255)));

        return buffer;
}


guint utils_invert_color(guint color)
{
        guint r, g, b;

        r = 0xffffff - color;
        g = 0xffffff - (color >> 8);
        b = 0xffffff - (color >> 16);

        return (r | (g << 8) | (b << 16));
}


/* Get directory from current file in the notebook.
 * Returns dir string that should be freed or NULL, depending on whether current file is valid.
 * Returned string is in UTF-8 encoding */
gchar *utils_get_current_file_dir_utf8(void)
{
        GeanyDocument *doc = document_get_current();

        if (doc != NULL)
        {
                /* get current filename */
                const gchar *cur_fname = doc->file_name;

                if (cur_fname != NULL)
                {
                        /* get folder part from current filename */
                        return g_path_get_dirname(cur_fname); /* returns "." if no path */
                }
        }

        return NULL; /* no file open */
}


/* very simple convenience function */
void utils_beep(void)
{
        if (prefs.beep_on_errors)
                gdk_beep();
}


/* taken from busybox, thanks */
gchar *utils_make_human_readable_str(guint64 size, gulong block_size,
                                                                         gulong display_unit)
{
        /* The code will adjust for additional (appended) units. */
        static const gchar zero_and_units[] = { '0', 0, 'K', 'M', 'G', 'T' };
        static const gchar fmt[] = "%Lu %c%c";
        static const gchar fmt_tenths[] = "%Lu.%d %c%c";

        guint64 val;
        gint frac;
        const gchar *u;
        const gchar *f;

        u = zero_and_units;
        f = fmt;
        frac = 0;

        val = size * block_size;
        if (val == 0)
                return g_strdup(u);

        if (display_unit)
        {
                val += display_unit/2;  /* Deal with rounding. */
                val /= display_unit;    /* Don't combine with the line above!!! */
        }
        else
        {
                ++u;
                while ((val >= 1024) && (u < zero_and_units + sizeof(zero_and_units) - 1))
                {
                        f = fmt_tenths;
                        ++u;
                        frac = ((((gint)(val % 1024)) * 10) + (1024 / 2)) / 1024;
                        val /= 1024;
                }
                if (frac >= 10)
                {               /* We need to round up here. */
                        ++val;
                        frac = 0;
                }
        }

        /* If f==fmt then 'frac' and 'u' are ignored. */
        return g_strdup_printf(f, val, frac, *u, 'b');
}


 static guint utils_get_value_of_hex(const gchar ch)
{
        if (ch >= '0' && ch <= '9')
                return ch - '0';
        else if (ch >= 'A' && ch <= 'F')
                return ch - 'A' + 10;
        else if (ch >= 'a' && ch <= 'f')
                return ch - 'a' + 10;
        else
                return 0;
}


/* utils_strtod() converts a string containing a hex colour ("0x00ff00") into an integer.
 * Basically, it is the same as strtod() would do, but it does not understand hex colour values,
 * before ANSI-C99. With with_route set, it takes strings of the format "#00ff00".
 * Returns -1 on failure. */
gint utils_strtod(const gchar *source, gchar **end, gboolean with_route)
{
        guint red, green, blue, offset = 0;

        g_return_val_if_fail(source != NULL, -1);

        if (with_route && (strlen(source) != 7 || source[0] != '#'))
                return -1;
        else if (! with_route && (strlen(source) != 8 || source[0] != '0' ||
                (source[1] != 'x' && source[1] != 'X')))
        {
                return -1;
        }

        /* offset is set to 1 when the string starts with 0x, otherwise it starts with #
         * and we don't need to increase the index */
        if (! with_route)
                offset = 1;

        red = utils_get_value_of_hex(
                                        source[1 + offset]) * 16 + utils_get_value_of_hex(source[2 + offset]);
        green = utils_get_value_of_hex(
                                        source[3 + offset]) * 16 + utils_get_value_of_hex(source[4 + offset]);
        blue = utils_get_value_of_hex(
                                        source[5 + offset]) * 16 + utils_get_value_of_hex(source[6 + offset]);

        return (red | (green << 8) | (blue << 16));
}


/* Returns: newly allocated string with the current time formatted HH:MM:SS. */
gchar *utils_get_current_time_string(void)
{
        const time_t tp = time(NULL);
        const struct tm *tmval = localtime(&tp);
        gchar *result = g_malloc0(9);

        strftime(result, 9, "%H:%M:%S", tmval);
        result[8] = '\0';
        return result;
}


GIOChannel *utils_set_up_io_channel(
                                gint fd, GIOCondition cond, gboolean nblock, GIOFunc func, gpointer data)
{
        GIOChannel *ioc;
        /*const gchar *encoding;*/

        #ifdef G_OS_WIN32
        ioc = g_io_channel_win32_new_fd(fd);
        #else
        ioc = g_io_channel_unix_new(fd);
        #endif

        if (nblock)
                g_io_channel_set_flags(ioc, G_IO_FLAG_NONBLOCK, NULL);

        g_io_channel_set_encoding(ioc, NULL, NULL);
/*
        if (! g_get_charset(&encoding))
        {       // hope this works reliably
                GError *error = NULL;
                g_io_channel_set_encoding(ioc, encoding, &error);
                if (error)
                {
                        geany_debug("%s: %s", G_STRFUNC, error->message);
                        g_error_free(error);
                        return ioc;
                }
        }
*/
        /* "auto-close" ;-) */
        g_io_channel_set_close_on_unref(ioc, TRUE);

        g_io_add_watch(ioc, cond, func, data);
        g_io_channel_unref(ioc);

        return ioc;
}


gchar **utils_read_file_in_array(const gchar *filename)
{
        gchar **result = NULL;
        gchar *data;

        g_return_val_if_fail(filename != NULL, NULL);

        g_file_get_contents(filename, &data, NULL, NULL);

        if (data != NULL)
        {
                result = g_strsplit_set(data, "\r\n", -1);
                g_free(data);
        }

        return result;
}


/* Contributed by Stefan Oltmanns, thanks.
 * Replaces \\, \r, \n, \t and \uXXX by their real counterparts.
 * keep_backslash is used for regex strings to leave '\\' and '\?' in place */
gboolean utils_str_replace_escape(gchar *string, gboolean keep_backslash)
{
        gsize i, j, len;
        guint unicodechar;

        g_return_val_if_fail(string != NULL, FALSE);

        j = 0;
        len = strlen(string);
        for (i = 0; i < len; i++)
        {
                if (string[i]=='\\')
                {
                        if (i++ >= strlen(string))
                        {
                                return FALSE;
                        }
                        switch (string[i])
                        {
                                case '\\':
                                        if (keep_backslash)
                                                string[j++] = '\\';
                                        string[j] = '\\';
                                        break;
                                case 'n':
                                        string[j] = '\n';
                                        break;
                                case 'r':
                                        string[j] = '\r';
                                        break;
                                case 't':
                                        string[j] = '\t';
                                        break;
#if 0
                                case 'x': /* Warning: May produce illegal utf-8 string! */
                                        i += 2;
                                        if (i >= strlen(string))
                                        {
                                                return FALSE;
                                        }
                                        if (isdigit(string[i - 1])) string[j] = string[i - 1] - 48;
                                        else if (isxdigit(string[i - 1])) string[j] = tolower(string[i - 1])-87;
                                        else return FALSE;
                                        string[j] <<= 4;
                                        if (isdigit(string[i])) string[j] |= string[i] - 48;
                                        else if (isxdigit(string[i])) string[j] |= tolower(string[i])-87;
                                        else return FALSE;
                                        break;
#endif
                                case 'u':
                                {
                                        i += 2;
                                        if (i >= strlen(string))
                                        {
                                                return FALSE;
                                        }
                                        if (isdigit(string[i - 1])) unicodechar = string[i - 1] - 48;
                                        else if (isxdigit(string[i - 1])) unicodechar = tolower(string[i - 1])-87;
                                        else return FALSE;
                                        unicodechar <<= 4;
                                        if (isdigit(string[i])) unicodechar |= string[i] - 48;
                                        else if (isxdigit(string[i])) unicodechar |= tolower(string[i])-87;
                                        else return FALSE;
                                        if (((i + 2) < strlen(string)) && (isdigit(string[i + 1]) || isxdigit(string[i + 1]))
                                                && (isdigit(string[i + 2]) || isxdigit(string[i + 2])))
                                        {
                                                i += 2;
                                                unicodechar <<= 8;
                                                if (isdigit(string[i - 1])) unicodechar |= ((string[i - 1] - 48) << 4);
                                                else unicodechar |= ((tolower(string[i - 1])-87) << 4);
                                                if (isdigit(string[i])) unicodechar |= string[i] - 48;
                                                else unicodechar |= tolower(string[i])-87;
                                        }
                                        if (((i + 2) < strlen(string)) && (isdigit(string[i + 1]) || isxdigit(string[i + 1]))
                                                && (isdigit(string[i + 2]) || isxdigit(string[i + 2])))
                                        {
                                                i += 2;
                                                unicodechar <<= 8;
                                                if (isdigit(string[i - 1])) unicodechar |= ((string[i - 1] - 48) << 4);
                                                else unicodechar |= ((tolower(string[i - 1])-87) << 4);
                                                if (isdigit(string[i])) unicodechar |= string[i] - 48;
                                                else unicodechar |= tolower(string[i])-87;
                                        }
                                        if (unicodechar < 0x80)
                                        {
                                                string[j] = unicodechar;
                                        }
                                        else if (unicodechar < 0x800)
                                        {
                                                string[j] = (unsigned char) ((unicodechar >> 6) | 0xC0);
                                                j++;
                                                string[j] = (unsigned char) ((unicodechar & 0x3F) | 0x80);
                                        }
                                        else if (unicodechar < 0x10000)
                                        {
                                                string[j] = (unsigned char) ((unicodechar >> 12) | 0xE0);
                                                j++;
                                                string[j] = (unsigned char) (((unicodechar >> 6) & 0x3F) | 0x80);
                                                j++;
                                                string[j] = (unsigned char) ((unicodechar & 0x3F) | 0x80);
                                        }
                                        else if (unicodechar < 0x110000) /* more chars are not allowed in unicode */
                                        {
                                                string[j] = (unsigned char) ((unicodechar >> 18) | 0xF0);
                                                j++;
                                                string[j] = (unsigned char) (((unicodechar >> 12) & 0x3F) | 0x80);
                                                j++;
                                                string[j] = (unsigned char) (((unicodechar >> 6) & 0x3F) | 0x80);
                                                j++;
                                                string[j] = (unsigned char) ((unicodechar & 0x3F) | 0x80);
                                        }
                                        else
                                        {
                                                return FALSE;
                                        }
                                        break;
                                }
                                default:
                                        /* unnecessary escapes are allowed */
                                        if (keep_backslash)
                                                string[j++] = '\\';
                                        string[j] = string[i];
                        }
                }
                else
                {
                        string[j] = string[i];
                }
                j++;
        }
        while (j < i)
        {
                string[j] = 0;
                j++;
        }
        return TRUE;
}


/* Wraps a string in place, replacing a space with a newline character.
 * wrapstart is the minimum position to start wrapping or -1 for default */
gboolean utils_wrap_string(gchar *string, gint wrapstart)
{
        gchar *pos, *linestart;
        gboolean ret = FALSE;

        if (wrapstart < 0)
                wrapstart = 80;

        for (pos = linestart = string; *pos != '\0'; pos++)
        {
                if (pos - linestart >= wrapstart && *pos == ' ')
                {
                        *pos = '\n';
                        linestart = pos;
                        ret = TRUE;
                }
        }
        return ret;
}


/**
 *  Converts the given UTF-8 encoded string into locale encoding.
 *  On Windows platforms, it does nothing and instead it just returns a copy of the input string.
 *
 *  @param utf8_text UTF-8 encoded text.
 *
 *  @return The converted string in locale encoding, or a copy of the input string if conversion
 *    failed. Should be freed with g_free(). If @a utf8_text is @c NULL, @c NULL is returned.
 **/
gchar *utils_get_locale_from_utf8(const gchar *utf8_text)
{
#ifdef G_OS_WIN32
        /* just do nothing on Windows platforms, this ifdef is just to prevent unwanted conversions
         * which would result in wrongly converted strings */
        return g_strdup(utf8_text);
#else
        gchar *locale_text;

        if (! utf8_text)
                return NULL;
        locale_text = g_locale_from_utf8(utf8_text, -1, NULL, NULL, NULL);
        if (locale_text == NULL)
                locale_text = g_strdup(utf8_text);
        return locale_text;
#endif
}


/**
 *  Converts the given string (in locale encoding) into UTF-8 encoding.
 *  On Windows platforms, it does nothing and instead it just returns a copy of the input string.
 *
 *  @param locale_text Text in locale encoding.
 *
 *  @return The converted string in UTF-8 encoding, or a copy of the input string if conversion
 *    failed. Should be freed with g_free(). If @a locale_text is @c NULL, @c NULL is returned.
 **/
gchar *utils_get_utf8_from_locale(const gchar *locale_text)
{
#ifdef G_OS_WIN32
        /* just do nothing on Windows platforms, this ifdef is just to prevent unwanted conversions
         * which would result in wrongly converted strings */
        return g_strdup(locale_text);
#else
        gchar *utf8_text;

        if (! locale_text)
                return NULL;
        utf8_text = g_locale_to_utf8(locale_text, -1, NULL, NULL, NULL);
        if (utf8_text == NULL)
                utf8_text = g_strdup(locale_text);
        return utf8_text;
#endif
}


/* Pass pointers to free after arg_count.
 * The last argument must be NULL as an extra check that arg_count is correct. */
void utils_free_pointers(gsize arg_count, ...)
{
        va_list a;
        gsize i;
        gpointer ptr;

        va_start(a, arg_count);
        for (i = 0; i < arg_count; i++)
        {
                ptr = va_arg(a, gpointer);
                g_free(ptr);
        }
        ptr = va_arg(a, gpointer);
        if (ptr)
                g_warning("Wrong arg_count!");
        va_end(a);
}


/* Creates a string array deep copy of a series of non-NULL strings.
 * The first argument is nothing special.
 * The list must be ended with NULL.
 * If first is NULL, NULL is returned. */
gchar **utils_strv_new(const gchar *first, ...)
{
        gsize strvlen, i;
        va_list args;
        gchar *str;
        gchar **strv;

        g_return_val_if_fail(first != NULL, NULL);

        strvlen = 1;    /* for first argument */

    /* count other arguments */
    va_start(args, first);
    for (; va_arg(args, gchar*) != NULL; strvlen++);
        va_end(args);

        strv = g_new(gchar*, strvlen + 1);      /* +1 for NULL terminator */
        strv[0] = g_strdup(first);

    va_start(args, first);
    for (i = 1; str = va_arg(args, gchar*), str != NULL; i++)
    {
                strv[i] = g_strdup(str);
        }
        va_end(args);

        strv[i] = NULL;
        return strv;
}


/**
 *  Creates a directory if it doesn't already exist.
 *  Creates intermediate parent directories as needed, too.
 *  The permissions of the created directory are set 0700.
 *
 *  @param path The path of the directory to create, in locale encoding.
 *  @param create_parent_dirs Whether to create intermediate parent directories if necessary.
 *
 *  @return 0 if the directory was successfully created, otherwise the @c errno of the
 *          failed operation is returned.
 **/
gint utils_mkdir(const gchar *path, gboolean create_parent_dirs)
{
        gint mode = 0700;
        gint result;

        if (path == NULL || strlen(path) == 0)
                return EFAULT;

        result = (create_parent_dirs) ? g_mkdir_with_parents(path, mode) : g_mkdir(path, mode);
        if (result != 0)
                return errno;
        return 0;
}


/**
 * Gets a list of files from the specified directory.
 * Locale encoding is expected for @a path and used for the file list. The list and the data
 * in the list should be freed after use, e.g.:
 * @code
 * g_slist_foreach(list, (GFunc) g_free, NULL);
 * g_slist_free(list); @endcode
 *
 * @note If you don't need a list you should use the foreach_dir() macro instead -
 * it's more efficient.
 *
 * @param path The path of the directory to scan, in locale encoding.
 * @param full_path Whether to include the full path for each filename in the list. Obviously this
 * will use more memory.
 * @param sort Whether to sort alphabetically (UTF-8 safe).
 * @param error The location for storing a possible error, or @c NULL.
 *
 * @return A newly allocated list or @c NULL if no files were found. The list and its data should be
 * freed when no longer needed.
 * @see utils_get_file_list().
 **/
GSList *utils_get_file_list_full(const gchar *path, gboolean full_path, gboolean sort, GError **error)
{
        GSList *list = NULL;
        GDir *dir;
        const gchar *filename;

        if (error)
                *error = NULL;
        g_return_val_if_fail(path != NULL, NULL);

        dir = g_dir_open(path, 0, error);
        if (dir == NULL)
                return NULL;

        foreach_dir(filename, dir)
        {
                list = g_slist_append(list, full_path ?
                        g_build_path(G_DIR_SEPARATOR_S, path, filename, NULL) : g_strdup(filename));
        }
        g_dir_close(dir);
        /* sorting last is quicker than on insertion */
        if (sort)
                list = g_slist_sort(list, (GCompareFunc) utils_str_casecmp);
        return list;
}


/**
 * Gets a sorted list of files from the specified directory.
 * Locale encoding is expected for @a path and used for the file list. The list and the data
 * in the list should be freed after use, e.g.:
 * @code
 * g_slist_foreach(list, (GFunc) g_free, NULL);
 * g_slist_free(list); @endcode
 *
 * @param path The path of the directory to scan, in locale encoding.
 * @param length The location to store the number of non-@c NULL data items in the list,
 *               unless @c NULL.
 * @param error The location for storing a possible error, or @c NULL.
 *
 * @return A newly allocated list or @c NULL if no files were found. The list and its data should be
 *         freed when no longer needed.
 * @see utils_get_file_list_full().
 **/
GSList *utils_get_file_list(const gchar *path, guint *length, GError **error)
{
        GSList *list = utils_get_file_list_full(path, FALSE, TRUE, error);

        if (length)
                *length = g_slist_length(list);
        return list;
}


/* returns TRUE if any letter in str is a capital, FALSE otherwise. Should be Unicode safe. */
gboolean utils_str_has_upper(const gchar *str)
{
        gunichar c;

        if (! NZV(str) || ! g_utf8_validate(str, -1, NULL))
                return FALSE;

        while (*str != '\0')
        {
                c = g_utf8_get_char(str);
                /* check only letters and stop once the first non-capital was found */
                if (g_unichar_isalpha(c) && g_unichar_isupper(c))
                        return TRUE;
                /* FIXME don't write a const string */
                str = g_utf8_next_char(str);
        }
        return FALSE;
}


static guint utils_string_replace_helper(GString *haystack, const gchar *needle,
                                                                                 const gchar *replace, const guint max_replaces)
{
        const gchar *stack, *match;
        guint ret = 0;
        gssize pos;

        g_return_val_if_fail(haystack != NULL, 0);
        if (haystack->len == 0)
                return FALSE;
        g_return_val_if_fail(NZV(needle), 0);

        stack = haystack->str;
        if (! (match = strstr(stack, needle)))
                return 0;
        do
        {
                pos = match - haystack->str;
                g_string_erase(haystack, pos, strlen(needle));

                /* make next search after removed matching text.
                 * (we have to be careful to only use haystack->str as its address may change) */
                stack = haystack->str + pos;

                if (G_LIKELY(replace))
                {
                        g_string_insert(haystack, pos, replace);
                        stack = haystack->str + pos + strlen(replace);  /* skip past replacement */
                }
        }
        while (++ret != max_replaces && (match = strstr(stack, needle)));

        return ret;
}


/**
 * Replaces all occurrences of @a needle in @a haystack with @a replace.
 * As of Geany 0.16, @a replace can match @a needle, so the following will work:
 * @code utils_string_replace_all(text, "\n", "\r\n"); @endcode
 *
 * @param haystack The input string to operate on. This string is modified in place.
 * @param needle The string which should be replaced.
 * @param replace The replacement for @a needle.
 *
 * @return Number of replacements made.
 **/
guint utils_string_replace_all(GString *haystack, const gchar *needle, const gchar *replace)
{
        return utils_string_replace_helper(haystack, needle, replace, 0);
}


/**
 * Replaces only the first occurrence of @a needle in @a haystack
 * with @a replace.
 * For details, see utils_string_replace_all().
 *
 * @param haystack The input string to operate on. This string is modified in place.
 * @param needle The string which should be replaced.
 * @param replace The replacement for @a needle.
 *
 * @return Number of replacements made.
 *
 *  @since 0.16
 */
guint utils_string_replace_first(GString *haystack, const gchar *needle, const gchar *replace)
{
        return utils_string_replace_helper(haystack, needle, replace, 1);
}


/* Get project or default startup directory (if set), or NULL. */
const gchar *utils_get_default_dir_utf8(void)
{
        if (app->project && NZV(app->project->base_path))
        {
                return app->project->base_path;
        }

        if (NZV(prefs.default_open_path))
        {
                return prefs.default_open_path;
        }
        return NULL;
}


static gboolean check_error(GError **error)
{
        if (error != NULL && *error != NULL)
        {
                /* imitate the GLib warning */
                g_warning(
                        "GError set over the top of a previous GError or uninitialized memory.\n"
                        "This indicates a bug in someone's code. You must ensure an error is NULL "
                        "before it's set.");
                /* after returning the code may segfault, but we don't care because we should
                 * make sure *error is NULL */
                return FALSE;
        }
        return TRUE;
}


/**
 *  Wraps g_spawn_sync() and internally calls this function on Unix-like
 *  systems. On Win32 platforms, it uses the Windows API.
 *
 *  @param dir The child's current working directory, or @a NULL to inherit parent's.
 *  @param argv The child's argument vector.
 *  @param env The child's environment, or @a NULL to inherit parent's.
 *  @param flags Flags from GSpawnFlags.
 *  @param child_setup A function to run in the child just before exec().
 *  @param user_data The user data for child_setup.
 *  @param std_out The return location for child output.
 *  @param std_err The return location for child error messages.
 *  @param exit_status The child exit status, as returned by waitpid().
 *  @param error The return location for error or @a NULL.
 *
 *  @return @c TRUE on success, @c FALSE if an error was set.
 **/
gboolean utils_spawn_sync(const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
                                                  GSpawnChildSetupFunc child_setup, gpointer user_data, gchar **std_out,
                                                  gchar **std_err, gint *exit_status, GError **error)
{
        gboolean result;

        if (! check_error(error))
                return FALSE;

        if (argv == NULL)
        {
                *error = g_error_new(G_SPAWN_ERROR, G_SPAWN_ERROR_FAILED, "argv must not be NULL");
                return FALSE;
        }

        if (std_out)
                *std_out = NULL;

        if (std_err)
                *std_err = NULL;

#ifdef G_OS_WIN32
        result = win32_spawn(dir, argv, env, flags, std_out, std_err, exit_status, error);
#else
        result = g_spawn_sync(dir, argv, env, flags, NULL, NULL, std_out, std_err, exit_status, error);
#endif

        return result;
}


/**
 *  Wraps g_spawn_async() and internally calls this function on Unix-like
 *  systems. On Win32 platforms, it uses the Windows API.
 *
 *  @param dir The child's current working directory, or @a NULL to inherit parent's.
 *  @param argv The child's argument vector.
 *  @param env The child's environment, or @a NULL to inherit parent's.
 *  @param flags Flags from GSpawnFlags.
 *  @param child_setup A function to run in the child just before exec().
 *  @param user_data The user data for child_setup.
 *  @param child_pid The return location for child process ID, or NULL.
 *  @param error The return location for error or @a NULL.
 *
 *  @return @c TRUE on success, @c FALSE if an error was set.
 **/
gboolean utils_spawn_async(const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
                                                   GSpawnChildSetupFunc child_setup, gpointer user_data, GPid *child_pid,
                                                   GError **error)
{
        gboolean result;

        if (! check_error(error))
                return FALSE;

        if (argv == NULL)
        {
                *error = g_error_new(G_SPAWN_ERROR, G_SPAWN_ERROR_FAILED, "argv must not be NULL");
                return FALSE;
        }

#ifdef G_OS_WIN32
        result = win32_spawn(dir, argv, env, flags, NULL, NULL, NULL, error);
#else
        result = g_spawn_async(dir, argv, env, flags, NULL, NULL, child_pid, error);
#endif
        return result;
}


/* Similar to g_build_path() but (re)using a fixed buffer, so never free it.
 * This assumes a small enough resulting string length to be kept without freeing,
 * but this should be the case for filenames.
 * @warning As the buffer is reused, you can't call this recursively, e.g. for a
 * function argument and within the function called. */
const gchar *utils_build_path(const gchar *first, ...)
{
        static GString *buffer = NULL;
        const gchar *str;
        va_list args;

        if (! buffer)
                buffer = g_string_new(first);
        else
                g_string_assign(buffer, first);

        va_start(args, first);
        while (1)
        {
                str = va_arg(args, const gchar *);
                if (!str)
                        break;

                g_string_append_c(buffer, G_DIR_SEPARATOR);
                g_string_append(buffer, str);
        }
        va_end(args);

        return buffer->str;
}


/* Retrieves the path for the given URI.
 * It returns:
 * - the path which was determined by g_filename_from_uri() or GIO
 * - NULL if the URI is non-local and gvfs-fuse is not installed
 * - a new copy of 'uri' if it is not an URI. */
gchar *utils_get_path_from_uri(const gchar *uri)
{
        gchar *locale_filename;

        g_return_val_if_fail(uri != NULL, NULL);

        if (! utils_is_uri(uri))
                return g_strdup(uri);

        /* this will work only for 'file://' URIs */
        locale_filename = g_filename_from_uri(uri, NULL, NULL);
#ifdef HAVE_GIO
        /* g_filename_from_uri() failed, so we probably have a non-local URI */
        if (locale_filename == NULL)
        {
                GFile *file = g_file_new_for_uri(uri);
                locale_filename = g_file_get_path(file);
                g_object_unref(file);
                if (locale_filename == NULL)
                {
                        geany_debug("The URI '%s' could not be resolved to a local path. This means "
                                "that the URI is invalid or that you don't have gvfs-fuse installed.", uri);
                        return NULL;
                }
        }
#endif
        if (locale_filename == NULL)
                geany_debug("The URI '%s' could not be resolved to a local path. This means that the "
                        "URI is invalid or that Geany can't use GVFS (maybe it is not installed).", uri);

        return locale_filename;
}


gboolean utils_is_uri(const gchar *uri)
{
        g_return_val_if_fail(uri != NULL, FALSE);

        return (strstr(uri, "://") != NULL);
}


/* path should be in locale encoding */
gboolean utils_is_remote_path(const gchar *path)
{
        g_return_val_if_fail(path != NULL, FALSE);

        /* if path is an URI and it doesn't start "file://", we take it as remote */
        if (utils_is_uri(path) && strncmp(path, "file:", 5) != 0)
                return TRUE;

#ifndef G_OS_WIN32
        if (glib_check_version(2, 16, 0) == NULL) /* no need to check for this with GLib < 2.16 */
        {
                static gchar *fuse_path = NULL;
                static gsize len = 0;

                if (G_UNLIKELY(fuse_path == NULL))
                {
                        fuse_path = g_build_filename(g_get_home_dir(), ".gvfs", NULL);
                        len = strlen(fuse_path);
                }
                /* Comparing the file path against a hardcoded path is not the most elegant solution
                 * but for now it is better than nothing. Ideally, g_file_new_for_path() should create
                 * proper GFile objects for Fuse paths, but it only does in future GVFS
                 * versions (gvfs 1.1.1). */
                return (strncmp(path, fuse_path, len) == 0);
        }
#endif
        return FALSE;
}


/* Remove all relative and untidy elements from the path of @a filename.
 * @param filename must be a valid absolute path.
 * @see tm_get_real_path() - also resolves links. */
void utils_tidy_path(gchar *filename)
{
        GString *str = g_string_new(filename);
        const gchar *c, *needle;
        gchar *tmp;
        gssize pos;
        gboolean preserve_double_backslash = FALSE;

        g_return_if_fail(g_path_is_absolute(filename));

        if (str->len >= 2 && strncmp(str->str, "\\\\", 2) == 0)
                preserve_double_backslash = TRUE;

        /* replace "/./" and "//" */
        utils_string_replace_all(str, G_DIR_SEPARATOR_S "." G_DIR_SEPARATOR_S, G_DIR_SEPARATOR_S);
        utils_string_replace_all(str, G_DIR_SEPARATOR_S G_DIR_SEPARATOR_S, G_DIR_SEPARATOR_S);

        if (preserve_double_backslash)
                g_string_prepend(str, "\\");

        /* replace "/../" */
        needle = G_DIR_SEPARATOR_S ".." G_DIR_SEPARATOR_S;
        while (1)
        {
                c = strstr(str->str, needle);
                if (c == NULL)
                        break;
                else
                {
                        pos = c - str->str;
                        if (pos <= 3)
                                break;  /* bad path */

                        /* replace "/../" */
                        g_string_erase(str, pos, strlen(needle));
                        g_string_insert_c(str, pos, G_DIR_SEPARATOR);

                        tmp = g_strndup(str->str, pos); /* path up to "/../" */
                        c = g_strrstr(tmp, G_DIR_SEPARATOR_S);
                        g_return_if_fail(c);

                        pos = c - tmp;  /* position of previous "/" */
                        g_string_erase(str, pos, strlen(c));
                        g_free(tmp);
                }
        }
        g_return_if_fail(strlen(str->str) <= strlen(filename));
        strcpy(filename, str->str);
        g_string_free(str, TRUE);
}


/**
 *  Removes characters from a string, in place.
 *
 *  @param string String to search.
 *  @param chars Characters to remove.
 *
 *  @return @a string - return value is only useful when nesting function calls, e.g.:
 *  @code str = utils_str_remove_chars(g_strdup("f_o_o"), "_"); @endcode
 *
 *  @see @c g_strdelimit.
 **/
gchar *utils_str_remove_chars(gchar *string, const gchar *chars)
{
        const gchar *r;
        gchar *w = string;

        g_return_val_if_fail(string, NULL);
        if (!NZV(chars))
                return string;

        foreach_str(r, string)
        {
                if (!strchr(chars, *r))
                        *w++ = *r;
        }
        *w = 0x0;
        return string;
}


static void utils_slist_remove_next(GSList *node)
{
        GSList *old = node->next;

        g_return_if_fail(old);

        node->next = old->next;
        g_slist_free_1(old);
}


/* Gets list of sorted filenames with no path and no duplicates from user and system config */
GSList *utils_get_config_files(const gchar *subdir)
{
        gchar *path = g_build_path(G_DIR_SEPARATOR_S, app->configdir, subdir, NULL);
        GSList *list = utils_get_file_list_full(path, FALSE, FALSE, NULL);
        GSList *syslist, *node;

        if (!list)
        {
                utils_mkdir(path, FALSE);
        }
        setptr(path, g_build_path(G_DIR_SEPARATOR_S, app->datadir, subdir, NULL));
        syslist = utils_get_file_list_full(path, FALSE, FALSE, NULL);
        /* merge lists */
        list = g_slist_concat(list, syslist);

        list = g_slist_sort(list, (GCompareFunc) utils_str_casecmp);
        /* remove duplicates (next to each other after sorting) */
        foreach_slist(node, list)
        {
                if (node->next && utils_str_equal(node->next->data, node->data))
                {
                        g_free(node->next->data);
                        utils_slist_remove_next(node);
                }
        }
        g_free(path);
        return list;
}


/* Suffix can be NULL or a string which should be appended to the Help URL like
 * an anchor link, e.g. "#some_anchor". */
gchar *utils_get_help_url(const gchar *suffix)
{
        gint skip;
        gchar *uri;

#ifdef G_OS_WIN32
        skip = 8;
        uri = g_strconcat("file:///", app->docdir, "/Manual.html", NULL);
        g_strdelimit(uri, "\\", '/'); /* replace '\\' by '/' */
#else
        skip = 7;
        uri = g_strconcat("file://", app->docdir, "index.html", NULL);
#endif

        if (! g_file_test(uri + skip, G_FILE_TEST_IS_REGULAR))
        {       /* fall back to online documentation if it is not found on the hard disk */
                g_free(uri);
                uri = g_strconcat(GEANY_HOMEPAGE, "manual/", VERSION, "/index.html", NULL);
        }

        if (suffix != NULL)
        {
                setptr(uri, g_strconcat(uri, suffix, NULL));
        }

        return uri;
}


static gboolean str_in_array(const gchar **haystack, const gchar *needle)
{
        const gchar **p;

        for (p = haystack; *p != NULL; ++p)
        {
                if (utils_str_equal(*p, needle))
                        return TRUE;
        }
        return FALSE;
}


/**
 * Copies the current environment into a new array.
 * @a exclude_vars is a @c NULL-terminated array of variable names which should be not copied.
 * All further arguments are key, value pairs of variables which should be added to
 * the environment.
 *
 * The argument list must be @c NULL-terminated.
 *
 * @param exclude_vars @c NULL-terminated array of variable names to exclude.
 * @param first_varname Name of the first variable to copy into the new array.
 * @param ... Key-value pairs of variable names and values, @c NULL-terminated.
 *
 * @return The new environment array.
 **/
gchar **utils_copy_environment(const gchar **exclude_vars, const gchar *first_varname, ...)
{
        gchar **result;
        gchar **p;
        gchar **env;
        va_list args;
        const gchar *key, *value;
        guint n, o;

        /* get all the environ variables */
        env = g_listenv();

        /* count the additional variables */
        va_start(args, first_varname);
        for (o = 1; va_arg(args, gchar*) != NULL; o++);
        va_end(args);
        /* the passed arguments should be even (key, value pairs) */
        g_return_val_if_fail(o % 2 == 0, NULL);

        o /= 2;

        /* create an array large enough to hold the new environment */
        n = g_strv_length(env);
        /* 'n + o + 1' could leak a little bit when exclude_vars is set */
        result = g_new(gchar *, n + o + 1);

        /* copy the environment */
        for (n = 0, p = env; *p != NULL; ++p)
        {
                /* copy the variable */
                value = g_getenv(*p);
                if (G_LIKELY(value != NULL))
                {
                        /* skip excluded variables */
                        if (exclude_vars != NULL && str_in_array(exclude_vars, *p))
                                continue;

                        result[n++] = g_strconcat(*p, "=", value, NULL);
                }
        }
        g_strfreev(env);

        /* now add additional variables */
        va_start(args, first_varname);
        key = first_varname;
        value = va_arg(args, gchar*);
        while (key != NULL)
        {
                result[n++] = g_strconcat(key, "=", value, NULL);

                key = va_arg(args, gchar*);
                if (key == NULL)
                        break;
                value = va_arg(args, gchar*);
        }
        va_end(args);

        result[n] = NULL;

        return result;
}