gimputils

gimputils — Utilities of general interest

Functions

Description

Utilities of general interest

Functions

gimp_any_to_utf8 ()

gchar *
gimp_any_to_utf8 (const gchar *str,
                  gssize len,
                  const gchar *warning_format,
                  ...);

This function takes any string (UTF-8 or not) and always returns a valid UTF-8 string.

If str is valid UTF-8, a copy of the string is returned.

If UTF-8 validation fails, g_locale_to_utf8() is tried and if it succeeds the resulting string is returned.

Otherwise, the portion of str that is UTF-8, concatenated with "(invalid UTF-8 string)" is returned. If not even the start of str is valid UTF-8, only "(invalid UTF-8 string)" is returned.

Parameters

str

The string to be converted to UTF-8.

 

len

The length of the string, or -1 if the string is nul-terminated.

 

warning_format

The message format for the warning message if conversion to UTF-8 fails. See the printf() documentation.

 

...

The parameters to insert into the format string.

 

Returns

The UTF-8 string as described above.


gimp_filename_to_utf8 ()

const gchar *
gimp_filename_to_utf8 (const gchar *filename);

Convert a filename in the filesystem's encoding to UTF-8 temporarily. The return value is a pointer to a string that is guaranteed to be valid only during the current iteration of the main loop or until the next call to gimp_filename_to_utf8().

The only purpose of this function is to provide an easy way to pass a filename in the filesystem encoding to a function that expects an UTF-8 encoded filename.

Parameters

filename

The filename to be converted to UTF-8.

 

Returns

A temporarily valid UTF-8 representation of filename . This string must not be changed or freed.


gimp_file_get_utf8_name ()

const gchar *
gimp_file_get_utf8_name (GFile *file);

This function works like gimp_filename_to_utf8() and returns a UTF-8 encoded string that does not need to be freed.

It converts a GFile's path or uri to UTF-8 temporarily. The return value is a pointer to a string that is guaranteed to be valid only during the current iteration of the main loop or until the next call to gimp_file_get_utf8_name().

The only purpose of this function is to provide an easy way to pass a GFile's name to a function that expects an UTF-8 encoded string.

See g_file_get_parse_name().

Parameters

file

a GFile

 

Returns

A temporarily valid UTF-8 representation of file 's name. This string must not be changed or freed.

Since: 2.10


gimp_file_has_extension ()

gboolean
gimp_file_has_extension (GFile *file,
                         const gchar *extension);

This function checks if file 's URI ends with extension . It behaves like g_str_has_suffix() on g_file_get_uri(), except that the string comparison is done case-insensitively using g_ascii_strcasecmp().

Parameters

file

a GFile

 

extension

an ASCII extension

 

Returns

TRUE if file 's URI ends with extension , FALSE otherwise.

Since: 2.10


gimp_file_show_in_file_manager ()

gboolean
gimp_file_show_in_file_manager (GFile *file,
                                GError **error);

Shows file in the system file manager.

Parameters

file

a GFile

 

error

return location for a GError

 

Returns

TRUE on success, FALSE otherwise. On FALSE, error is set.

Since: 2.10


gimp_utf8_strtrim ()

gchar *
gimp_utf8_strtrim (const gchar *str,
                   gint max_chars);

Creates a (possibly trimmed) copy of str . The string is cut if it exceeds max_chars characters or on the first newline. The fact that the string was trimmed is indicated by appending an ellipsis.

Parameters

str

an UTF-8 encoded string (or NULL)

 

max_chars

the maximum number of characters before the string get trimmed

 

Returns

A (possibly trimmed) copy of str which should be freed using g_free() when it is not needed any longer.


gimp_escape_uline ()

gchar *
gimp_escape_uline (const gchar *str);

This function returns a copy of str with all underline converted to two adjacent underlines. This comes in handy when needing to display strings with underlines (like filenames) in a place that would convert them to mnemonics.

Parameters

str

Underline infested string (or NULL)

 

Returns

A (possibly escaped) copy of str which should be freed using g_free() when it is not needed any longer.

Since: 2.2


gimp_strip_uline ()

gchar *
gimp_strip_uline (const gchar *str);

This function returns a copy of str stripped of underline cha