|  |  |  | Evolution-Data-Server Manual: Utilities (libedataserver) |  | 
|---|---|---|---|---|
| Top | Description | ||||
struct tm; const gchar * e_get_user_cache_dir (void); const gchar * e_get_user_config_dir (void); const gchar * e_get_user_data_dir (void); gchar * e_util_strstrcase (const gchar *haystack,const gchar *needle); gchar * e_util_unicode_get_utf8 (const gchar *text,gunichar *out); const gchar * e_util_utf8_strstrcase (const gchar *haystack,const gchar *needle); const gchar * e_util_utf8_strstrcasedecomp (const gchar *haystack,const gchar *needle); gint e_util_utf8_strcasecmp (const gchar *s1,const gchar *s2); gchar * e_util_utf8_remove_accents (const gchar *str); gchar * e_util_utf8_make_valid (const gchar *str); const gchar * e_util_ensure_gdbus_string (const gchar *str,gchar **gdbus_str); guint64 e_util_gthread_id (GThread *thread); void e_filename_make_safe (gchar *string); gsize e_utf8_strftime (gchar *string,gsize max,const gchar *fmt,const struct tm *tm); gsize e_strftime (gchar *string,gsize max,const gchar *fmt,const struct tm *tm); const gchar * e_util_get_prefix (void); const gchar * e_util_get_cp_prefix (void); const gchar * e_util_get_localedir (void); gchar * e_util_replace_prefix (const gchar *configure_time_prefix,const gchar *runtime_prefix,const gchar *configure_time_path); gint e_data_server_util_get_dbus_call_timeout (void); void e_data_server_util_set_dbus_call_timeout (gint timeout_msec);
const gchar *	      e_get_user_cache_dir                (void);
Returns a base directory in which to store user-specific, non-essential cached data for Evolution or Evolution-Data-Server.
The returned string is owned by libedataserver and must not be modified or freed.
| Returns : | base directory for user-specific, non-essential data | 
Since 2.32
const gchar *	      e_get_user_config_dir               (void);
Returns a base directory in which to store user-specific configuration information for Evolution or Evolution-Data-Server.
The returned string is owned by libedataserver and must not be modified or freed.
| Returns : | base directory for user-specific configuration information | 
Since 2.32
const gchar *	      e_get_user_data_dir                 (void);
Returns a base directory in which to store user-specific data for Evolution or Evolution-Data-Server.
The returned string is owned by libedataserver and must not be modified or freed.
| Returns : | base directory for user-specific data | 
Since 2.32
gchar * e_util_strstrcase (const gchar *haystack,const gchar *needle);
Find the first instance of needle in haystack, ignoring case for
bytes that are ASCII characters.
| 
 | The string to search in. | 
| 
 | The string to search for. | 
| Returns : | A pointer to the start of needleinhaystack, or NULL ifneedleis not found. | 
gchar * e_util_unicode_get_utf8 (const gchar *text,gunichar *out);
Get a UTF-8 character from the beginning of text.
| 
 | The string to take the UTF-8 character from. | 
| 
 | The location to store the UTF-8 character in. | 
| Returns : | A pointer to the next character in textafterout. | 
const gchar * e_util_utf8_strstrcase (const gchar *haystack,const gchar *needle);
Find the first instance of needle in haystack, ignoring case. (No
proper case folding or decomposing is done.) Both needle and
haystack are UTF-8 strings.
| 
 | The string to search in. | 
| 
 | The string to search for. | 
| Returns : | A pointer to the first instance of needleinhaystack, orNULLif no match is found, or if either of the strings are
not legal UTF-8 strings. | 
const gchar * e_util_utf8_strstrcasedecomp (const gchar *haystack,const gchar *needle);
Find the first instance of needle in haystack, where both needle
and haystack are UTF-8 strings. Both strings are stripped and
decomposed for comparison, and case is ignored.
| 
 | The string to search in. | 
| 
 | The string to search for. | 
| Returns : | A pointer to the first instance of needleinhaystack, orNULLif either of the strings are not legal UTF-8 strings. | 
gint e_util_utf8_strcasecmp (const gchar *s1,const gchar *s2);
Compares two UTF-8 strings using approximate case-insensitive ordering.
| 
 | a UTF-8 string | 
| 
 | another UTF-8 string | 
| Returns : | < 0 if s1compares befores2, 0 if they compare equal,
> 0 ifs1compares afters2 | 
gchar *		           e_util_utf8_remove_accents          (const gchar *str);
Returns a newly-allocated copy of str with accents removed.
| 
 | a UTF-8 string, or NULL | 
| Returns : | a newly-allocated string | 
Since 2.28
gchar *		           e_util_utf8_make_valid              (const gchar *str);
Returns a newly-allocated copy of str, with invalid characters
replaced by Unicode replacement characters (U+FFFD).
| 
 | a UTF-8 string | 
| Returns : | a newly-allocated string | 
Since 3.0
const gchar * e_util_ensure_gdbus_string (const gchar *str,gchar **gdbus_str);
If str is a valid UTF-8 string, the function returns str and does
not set gdbus_str.
If str is an invalid UTF-8 string, the function calls
e_util_utf8_make_valid() and points gdbus_str to the newly-allocated,
valid UTF-8 string, and also returns it.  The caller should free the
string pointed to by gdbus_str with g_free().
If str is NULL, the function returns an empty string and does not
set gdbus_str.
Admittedly, the function semantics are a little awkward.  The example
below illustrates the easiest way to cope with the gdbus_str argument:
<informalexample> <programlisting> const gchar *trusted_utf8; gchar *allocated = NULL;
trusted_utf8 = e_util_ensure_gdbus_string (untrusted_utf8, &allocated);
Do stuff with trusted_utf8, then clear it.
trusted_utf8 = NULL;
g_free (allocated); allocated = NULL; </programlisting> </informalexample>
| 
 | a possibly invalid UTF-8 string, or NULL | 
| 
 | return location for the corrected string | 
| Returns : | a valid UTF-8 string | 
Since 3.0
guint64             e_util_gthread_id                   (GThread *thread);
Returns a 64-bit integer hopefully uniquely identifying the thread. To be used in debugging output and logging only. The returned value is just a cast of a pointer to the 64-bit integer.
There is no guarantee that calling e_util_gthread_id() on one
thread first and later after that thread has dies on another won't
return the same integer.
On Linux and Win32, known to really return a unique id for each thread existing at a certain time. No guarantee that ids won't be reused after a thread has terminated, though.
| 
 | A GThread pointer | 
| Returns : | A 64-bit integer. | 
Since 2.32
gsize e_utf8_strftime (gchar *string,gsize max,const gchar *fmt,const struct tm *tm);
The UTF-8 equivalent of e_strftime().
| 
 | The string array to store the result in. | 
| 
 | The size of array s. | 
| 
 | The formatting to use on tm. | 
| 
 | The time value to format. | 
| Returns : | The number of characters placed in s. | 
gsize e_strftime (gchar *string,gsize max,const gchar *fmt,const struct tm *tm);
This function is a wrapper around the strftime (3) function, which converts the %l and %k (12h and 24h) format variables if necessary.
| 
 | The string array to store the result in. | 
| 
 | The size of array s. | 
| 
 | The formatting to use on tm. | 
| 
 | The time value to format. | 
| Returns : | The number of characters placed in s. | 
gchar * e_util_replace_prefix (const gchar *configure_time_prefix,const gchar *runtime_prefix,const gchar *configure_time_path);
gint                e_data_server_util_get_dbus_call_timeout
                                                        (void);
Returns the value set by e_data_server_util_set_dbus_call_timeout().
| Returns : | the D-Bus call timeout in milliseconds | 
Since 3.0
void                e_data_server_util_set_dbus_call_timeout
                                                        (gint timeout_msec);
Sets default timeout, in milliseconds, for calls of g_dbus_proxy_call()
family functions.
-1 means the default value as set by D-Bus itself. G_MAXINT means no timeout at all.
Default value is set also by configure option --with-dbus-call-timeout=ms and -1 is used when not set.
| 
 | default timeout for D-Bus calls in miliseconds | 
Since 3.0