2 * utils.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2011 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * General utility functions, non-GTK related.
30 #define GEANY_UTILS_H 1
36 /** Returns TRUE if @a ptr points to a non-zero value. */
38 (G_LIKELY((ptr)) && G_LIKELY((ptr)[0]))
41 * Frees @a ptr (if not @c NULL), then assigns @a result to it.
42 * @a result can be an expression using the 'old' value of @a ptr.
43 * It prevents a memory leak compared with: @code ptr = func(ptr); @endcode
45 #define setptr(ptr, result) \
47 gpointer setptr_tmp = ptr;\
52 /** Duplicates a string on the stack using @c g_alloca().
53 * Like glibc's @c strdupa(), but portable.
54 * @note You must include @c string.h yourself.
55 * @warning Don't use excessively or for long strings otherwise there may be stack exhaustion -
56 * see the GLib docs for @c g_alloca(). */
57 #define utils_strdupa(str) \
58 strcpy(g_alloca(strlen(str) + 1), str)
60 /* Get a keyfile setting, using the home keyfile if the key exists,
61 * otherwise system keyfile. */
62 #define utils_get_setting(type, home, sys, group, key, default_val)\
63 (g_key_file_has_key(home, group, key, NULL)) ?\
64 utils_get_setting_##type(home, group, key, default_val) :\
65 utils_get_setting_##type(sys, group, key, default_val)
68 /** Iterates all the items in @a array using pointers.
69 * @param item pointer to an item in @a array.
70 * @param array C array to traverse.
71 * @param len Length of the array. */
72 #define foreach_c_array(item, array, len) \
73 for (item = array; item < &array[len]; item++)
75 /** Iterates all items in @a array.
76 * @param type Type of @a item.
77 * @param item pointer to item in @a array.
78 * @param array @c GArray to traverse. */
79 #define foreach_array(type, item, array) \
80 foreach_c_array(item, ((type*)(gpointer)array->data), array->len)
82 /** Iterates all the pointers in @a ptr_array.
83 * @param item pointer in @a ptr_array.
84 * @param idx @c guint index into @a ptr_array.
85 * @param ptr_array @c GPtrArray to traverse. */
86 #define foreach_ptr_array(item, idx, ptr_array) \
87 for (idx = 0, item = g_ptr_array_index(ptr_array, 0); \
88 idx < ptr_array->len; ++idx, item = g_ptr_array_index(ptr_array, idx))
90 /** Iterates all the nodes in @a list.
91 * @param node should be a (@c GList*).
92 * @param list @c GList to traverse. */
93 #define foreach_list(node, list) \
94 for (node = list; node != NULL; node = node->next)
96 /** Iterates all the nodes in @a list.
97 * @param node should be a (@c GSList*).
98 * @param list @c GSList to traverse. */
99 #define foreach_slist(node, list) \
100 foreach_list(node, list)
102 /** Iterates through each unsorted filename in a @c GDir.
103 * @param filename (@c const @c gchar*) locale-encoded filename, without path. Do not modify or free.
104 * @param dir @c GDir created with @c g_dir_open(). Call @c g_dir_close() afterwards.
105 * @see utils_get_file_list() if you want a sorted list.
106 * @since Geany 0.19. */
107 #define foreach_dir(filename, dir)\
108 for ((filename) = g_dir_read_name(dir); (filename) != NULL; (filename) = g_dir_read_name(dir))
110 /** Iterates through each character in @a string.
111 * @param char_ptr Pointer to character.
112 * @param string String to traverse.
113 * @warning Doesn't include null terminating character.
114 * @since Geany 0.19. */
115 #define foreach_str(char_ptr, string) \
116 for (char_ptr = string; *char_ptr; char_ptr++)
118 /** Iterates a null-terminated string vector.
119 * @param str_ptr @c gchar** pointer to string element.
120 * @param strv Can be @c NULL.
121 * @since Geany 0.20 */
122 #define foreach_strv(str_ptr, strv)\
123 if (!(strv)) {} else foreach_str(str_ptr, strv)
125 /** Iterates from 0 to @a size.
127 * @param size Number of iterations.
128 * @since Geany 0.20. */
129 #define foreach_range(i, size) \
130 for (i = 0; i < size; i++)
133 void utils_open_browser(const gchar
*uri
);
135 gint
utils_get_line_endings(const gchar
* buffer
, glong size
);
137 gboolean
utils_isbrace(gchar c
, gboolean include_angles
);
139 gboolean
utils_is_opening_brace(gchar c
, gboolean include_angles
);
141 gint
utils_write_file(const gchar
*filename
, const gchar
*text
);
143 gchar
*utils_find_open_xml_tag(const gchar sel
[], gint size
);
145 gboolean
utils_is_short_html_tag(const gchar
*tag_name
);
147 void utils_ensure_same_eol_characters(GString
*string
, gint target_eol_mode
);
149 const gchar
*utils_get_eol_char(gint eol_mode
);
151 const gchar
*utils_get_eol_name(gint eol_mode
);
153 gboolean
utils_atob(const gchar
*str
);
155 void utils_tidy_path(gchar
*filename
);
157 gboolean
utils_is_absolute_path(const gchar
*path
);
159 const gchar
*utils_path_skip_root(const gchar
*path
);
161 gdouble
utils_scale_round(gdouble val
, gdouble factor
);
163 gboolean
utils_str_equal(const gchar
*a
, const gchar
*b
);
165 gchar
*utils_remove_ext_from_filename(const gchar
*filename
);
167 gchar
utils_brace_opposite(gchar ch
);
169 gchar
*utils_get_hostname(void);
171 guint
utils_string_replace_all(GString
*haystack
, const gchar
*needle
, const gchar
*replace
);
173 guint
utils_string_replace_first(GString
*haystack
, const gchar
*needle
, const gchar
*replace
);
175 void utils_str_replace_all(gchar
**haystack
, const gchar
*needle
, const gchar
*replacement
);
177 gint
utils_strpos(const gchar
* haystack
, const gchar
*needle
);
179 gchar
*utils_get_date_time(const gchar
*format
, time_t *time_to_use
);
181 gchar
*utils_get_initials(const gchar
*name
);
183 gboolean
utils_get_setting_boolean(GKeyFile
*config
, const gchar
*section
, const gchar
*key
, const gboolean default_value
);
185 gint
utils_get_setting_integer(GKeyFile
*config
, const gchar
*section
, const gchar
*key
, const gint default_value
);
187 gchar
*utils_get_setting_string(GKeyFile
*config
, const gchar
*section
, const gchar
*key
, const gchar
*default_value
);
189 gchar
*utils_get_hex_from_color(GdkColor
*color
);
191 guint
utils_invert_color(guint color
);
193 const gchar
*utils_get_default_dir_utf8(void);
195 gchar
*utils_get_current_file_dir_utf8(void);
197 void utils_beep(void);
199 gchar
*utils_make_human_readable_str(guint64 size
, gulong block_size
,
200 gulong display_unit
);
202 gint
utils_strtod(const gchar
*source
, gchar
**end
, gboolean with_route
);
204 gchar
*utils_get_current_time_string(void);
206 GIOChannel
*utils_set_up_io_channel(gint fd
, GIOCondition cond
, gboolean nblock
,
207 GIOFunc func
, gpointer data
);
209 gchar
**utils_read_file_in_array(const gchar
*filename
);
211 gboolean
utils_str_replace_escape(gchar
*string
, gboolean keep_backslash
);
213 gboolean
utils_wrap_string(gchar
*string
, gint wrapstart
);
215 gchar
*utils_get_locale_from_utf8(const gchar
*utf8_text
);
217 gchar
*utils_get_utf8_from_locale(const gchar
*locale_text
);
219 void utils_free_pointers(gsize arg_count
, ...) G_GNUC_NULL_TERMINATED
;
221 gchar
**utils_strv_new(const gchar
*first
, ...) G_GNUC_NULL_TERMINATED
;
223 gchar
**utils_strv_join(gchar
**first
, gchar
**second
) G_GNUC_WARN_UNUSED_RESULT
;
225 gint
utils_mkdir(const gchar
*path
, gboolean create_parent_dirs
);
227 GSList
*utils_get_file_list(const gchar
*path
, guint
*length
, GError
**error
);
229 GSList
*utils_get_file_list_full(const gchar
*path
, gboolean full_path
, gboolean sort
, GError
**error
);
231 GSList
*utils_get_config_files(const gchar
*subdir
);
233 gchar
*utils_get_help_url(const gchar
*suffix
);
235 gboolean
utils_str_has_upper(const gchar
*str
);
237 gint
utils_is_file_writable(const gchar
*locale_filename
);
240 gboolean
utils_spawn_sync(const gchar
*dir
, gchar
**argv
, gchar
**env
, GSpawnFlags flags
,
241 GSpawnChildSetupFunc child_setup
, gpointer user_data
, gchar
**std_out
,
242 gchar
**std_err
, gint
*exit_status
, GError
**error
);
244 gboolean
utils_spawn_async(const gchar
*dir
, gchar
**argv
, gchar
**env
, GSpawnFlags flags
,
245 GSpawnChildSetupFunc child_setup
, gpointer user_data
, GPid
*child_pid
,
248 gint
utils_str_casecmp(const gchar
*s1
, const gchar
*s2
);
250 const gchar
*utils_build_path(const gchar
*first
, ...) G_GNUC_NULL_TERMINATED
;
252 const gchar
*utils_make_filename(const gchar
*path
, ...) G_GNUC_NULL_TERMINATED
;
254 gchar
*utils_get_path_from_uri(const gchar
*uri
);
256 gboolean
utils_is_uri(const gchar
*uri
);
258 gboolean
utils_is_remote_path(const gchar
*path
);
260 gchar
*utils_str_middle_truncate(const gchar
*string
, guint truncate_length
);
262 gchar
*utils_str_remove_chars(gchar
*string
, const gchar
*chars
);
264 gchar
**utils_copy_environment(const gchar
**exclude_vars
, const gchar
*first_varname
, ...) G_GNUC_NULL_TERMINATED
;