X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgutils.h;h=4a6e93bcb8650a8e9cae70cacc41ec59fe97032b;hb=ecf1359191b2f796a7d63288652dd1a93525417d;hp=e4d82778a2181857fb543c483b7f4695377ce2f7;hpb=ba9fccf71e667c1d05d05fab794ab41b2c387a81;p=platform%2Fupstream%2Fglib.git diff --git a/glib/gutils.h b/glib/gutils.h index e4d8277..4a6e93b 100644 --- a/glib/gutils.h +++ b/glib/gutils.h @@ -12,9 +12,7 @@ * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * License along with this library; if not, see . */ /* @@ -24,42 +22,18 @@ * GLib at ftp://ftp.gtk.org/pub/gtk/. */ -#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION) -#error "Only can be included directly." -#endif - #ifndef __G_UTILS_H__ #define __G_UTILS_H__ +#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION) +#error "Only can be included directly." +#endif + #include #include G_BEGIN_DECLS -#ifdef G_OS_WIN32 - -/* On Win32, the canonical directory separator is the backslash, and - * the search path separator is the semicolon. Note that also the - * (forward) slash works as directory separator. - */ -#define G_DIR_SEPARATOR '\\' -#define G_DIR_SEPARATOR_S "\\" -#define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/') -#define G_SEARCHPATH_SEPARATOR ';' -#define G_SEARCHPATH_SEPARATOR_S ";" - -#else /* !G_OS_WIN32 */ - -/* Unix */ - -#define G_DIR_SEPARATOR '/' -#define G_DIR_SEPARATOR_S "/" -#define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR) -#define G_SEARCHPATH_SEPARATOR ':' -#define G_SEARCHPATH_SEPARATOR_S ":" - -#endif /* !G_OS_WIN32 */ - /* Define G_VA_COPY() to do the right thing for copying va_list variables. * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy. */ @@ -67,15 +41,15 @@ G_BEGIN_DECLS # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32)) # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2)) # elif defined (G_VA_COPY_AS_ARRAY) -# define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list)) +# define G_VA_COPY(ap1, ap2) memmove ((ap1), (ap2), sizeof (va_list)) # else /* va_list is a pointer */ # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2)) # endif /* va_list is a pointer */ #endif /* !G_VA_COPY */ -/* inlining hassle. for compilers that don't allow the `inline' keyword, +/* inlining hassle. for compilers that don't allow the 'inline' keyword, * mostly because of strict ANSI C compliance or dumbness, we try to fall - * back to either `__inline__' or `__inline'. + * back to either '__inline__' or '__inline'. * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be * actually *capable* to do function inlining, in which case inline * function bodies do make sense. we also define G_INLINE_FUNC to properly @@ -98,44 +72,50 @@ G_BEGIN_DECLS # endif #endif #ifdef G_IMPLEMENT_INLINES -# define G_INLINE_FUNC +# define G_INLINE_FUNC _GLIB_EXTERN # undef G_CAN_INLINE #elif defined (__GNUC__) # define G_INLINE_FUNC static __inline __attribute__ ((unused)) #elif defined (G_CAN_INLINE) # define G_INLINE_FUNC static inline #else /* can't inline */ -# define G_INLINE_FUNC +# define G_INLINE_FUNC _GLIB_EXTERN #endif /* !G_INLINE_FUNC */ -/* Retrive static string info - */ -#ifdef G_OS_WIN32 -#define g_get_user_name g_get_user_name_utf8 -#define g_get_real_name g_get_real_name_utf8 -#define g_get_home_dir g_get_home_dir_utf8 -#define g_get_tmp_dir g_get_tmp_dir_utf8 -#endif - -G_CONST_RETURN gchar* g_get_user_name (void); -G_CONST_RETURN gchar* g_get_real_name (void); -G_CONST_RETURN gchar* g_get_home_dir (void); -G_CONST_RETURN gchar* g_get_tmp_dir (void); -G_CONST_RETURN gchar* g_get_host_name (void); -gchar* g_get_prgname (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_user_name (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_real_name (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_home_dir (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_tmp_dir (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_host_name (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_prgname (void); +GLIB_AVAILABLE_IN_ALL void g_set_prgname (const gchar *prgname); -G_CONST_RETURN gchar* g_get_application_name (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_application_name (void); +GLIB_AVAILABLE_IN_ALL void g_set_application_name (const gchar *application_name); -void g_reload_user_special_dirs_cache (void); -G_CONST_RETURN gchar* g_get_user_data_dir (void); -G_CONST_RETURN gchar* g_get_user_config_dir (void); -G_CONST_RETURN gchar* g_get_user_cache_dir (void); -G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs (void); +GLIB_AVAILABLE_IN_ALL +void g_reload_user_special_dirs_cache (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_user_data_dir (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_user_config_dir (void); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_user_cache_dir (void); +GLIB_AVAILABLE_IN_ALL +const gchar * const * g_get_system_data_dirs (void); #ifdef G_OS_WIN32 /* This functions is not part of the public GLib API */ -G_CONST_RETURN gchar* G_CONST_RETURN * g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void)); +GLIB_AVAILABLE_IN_ALL +const gchar * const * g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void)); #endif #if defined (G_OS_WIN32) && defined (G_CAN_INLINE) && !defined (__cplusplus) @@ -143,7 +123,7 @@ G_CONST_RETURN gchar* G_CONST_RETURN * g_win32_get_system_data_dirs_for_module ( * g_get_system_data_dirs() in your code, never mind that that is * actually a macro and you will in fact call this inline function. */ -static inline G_CONST_RETURN gchar * G_CONST_RETURN * +static inline const gchar * const * _g_win32_get_system_data_dirs (void) { return g_win32_get_system_data_dirs_for_module ((void (*)(void)) &_g_win32_get_system_data_dirs); @@ -151,12 +131,12 @@ _g_win32_get_system_data_dirs (void) #define g_get_system_data_dirs _g_win32_get_system_data_dirs #endif -G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void); +GLIB_AVAILABLE_IN_ALL +const gchar * const * g_get_system_config_dirs (void); +GLIB_AVAILABLE_IN_ALL const gchar * g_get_user_runtime_dir (void); -G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void); - /** * GUserDirectory: * @G_USER_DIRECTORY_DESKTOP: the user's Desktop directory @@ -192,9 +172,18 @@ typedef enum { G_USER_N_DIRECTORIES } GUserDirectory; -G_CONST_RETURN gchar* g_get_user_special_dir (GUserDirectory directory); +GLIB_AVAILABLE_IN_ALL +const gchar * g_get_user_special_dir (GUserDirectory directory); -typedef struct _GDebugKey GDebugKey; +/** + * GDebugKey: + * @key: the string + * @value: the flag + * + * Associates a string with a bit flag. + * Used in g_parse_debug_string(). + */ +typedef struct _GDebugKey GDebugKey; struct _GDebugKey { const gchar *key; @@ -203,84 +192,53 @@ struct _GDebugKey /* Miscellaneous utility functions */ +GLIB_AVAILABLE_IN_ALL guint g_parse_debug_string (const gchar *string, const GDebugKey *keys, guint nkeys); +GLIB_AVAILABLE_IN_ALL gint g_snprintf (gchar *string, gulong n, gchar const *format, ...) G_GNUC_PRINTF (3, 4); +GLIB_AVAILABLE_IN_ALL gint g_vsnprintf (gchar *string, gulong n, gchar const *format, - va_list args); - -/* Check if a file name is an absolute path */ -gboolean g_path_is_absolute (const gchar *file_name); - -/* In case of absolute paths, skip the root part */ -G_CONST_RETURN gchar* g_path_skip_root (const gchar *file_name); - -#ifndef G_DISABLE_DEPRECATED - -/* These two functions are deprecated and will be removed in the next - * major release of GLib. Use g_path_get_dirname/g_path_get_basename - * instead. Whatch out! The string returned by g_path_get_basename - * must be g_freed, while the string returned by g_basename must not.*/ -G_CONST_RETURN gchar* g_basename (const gchar *file_name); -#define g_dirname g_path_get_dirname + va_list args) + G_GNUC_PRINTF(3, 0); -#endif /* G_DISABLE_DEPRECATED */ +GLIB_AVAILABLE_IN_ALL +void g_nullify_pointer (gpointer *nullify_location); -#ifdef G_OS_WIN32 -#define g_get_current_dir g_get_current_dir_utf8 -#endif +typedef enum +{ + G_FORMAT_SIZE_DEFAULT = 0, + G_FORMAT_SIZE_LONG_FORMAT = 1 << 0, + G_FORMAT_SIZE_IEC_UNITS = 1 << 1 +} GFormatSizeFlags; -/* The returned strings are newly allocated with g_malloc() */ -gchar* g_get_current_dir (void); -gchar* g_path_get_basename (const gchar *file_name) G_GNUC_MALLOC; -gchar* g_path_get_dirname (const gchar *file_name) G_GNUC_MALLOC; +GLIB_AVAILABLE_IN_2_30 +gchar *g_format_size_full (guint64 size, + GFormatSizeFlags flags); +GLIB_AVAILABLE_IN_2_30 +gchar *g_format_size (guint64 size); -/* Set the pointer at the specified location to NULL */ -void g_nullify_pointer (gpointer *nullify_location); +GLIB_DEPRECATED_FOR(g_format_size) +gchar *g_format_size_for_display (goffset size); -/* return the environment string for the variable. The returned memory - * must not be freed. */ -#ifdef G_OS_WIN32 -#define g_getenv g_getenv_utf8 -#define g_setenv g_setenv_utf8 -#define g_unsetenv g_unsetenv_utf8 -#define g_find_program_in_path g_find_program_in_path_utf8 -#endif - -G_CONST_RETURN gchar* g_getenv (const gchar *variable); -gboolean g_setenv (const gchar *variable, - const gchar *value, - gboolean overwrite); -void g_unsetenv (const gchar *variable); -gchar** g_listenv (void); -gchar** g_get_environ (void); - -/* private */ -const gchar* _g_getenv_nomalloc (const gchar *variable, - gchar buffer[1024]); - -/* we try to provide a useful equivalent for ATEXIT if it is - * not defined, but use is actually abandoned. people should - * use g_atexit() instead. - */ -typedef void (*GVoidFunc) (void); -#ifndef ATEXIT -# define ATEXIT(proc) g_ATEXIT(proc) -#else -# define G_NATIVE_ATEXIT -#endif /* ATEXIT */ -/* we use a GLib function as a replacement for ATEXIT, so - * the programmer is not required to check the return value - * (if there is any in the implementation) and doesn't encounter - * missing include files. +#ifndef G_DISABLE_DEPRECATED +/** + * GVoidFunc: + * + * Declares a type of function which takes no arguments + * and has no return value. It is used to specify the type + * function passed to g_atexit(). */ +typedef void (*GVoidFunc) (void); +#define ATEXIT(proc) g_ATEXIT(proc) +GLIB_DEPRECATED void g_atexit (GVoidFunc func); #ifdef G_OS_WIN32 @@ -296,7 +254,11 @@ int atexit (void (*)(void)); #define g_atexit(func) atexit(func) #endif +#endif /* G_DISABLE_DEPRECATED */ + + /* Look for an executable in PATH, following execvp() rules */ +GLIB_AVAILABLE_IN_ALL gchar* g_find_program_in_path (const gchar *program); /* Bit tests @@ -307,21 +269,6 @@ G_INLINE_FUNC gint g_bit_nth_msf (gulong mask, gint nth_bit) G_GNUC_CONST; G_INLINE_FUNC guint g_bit_storage (gulong number) G_GNUC_CONST; -/* Trash Stacks - * elements need to be >= sizeof (gpointer) - */ -typedef struct _GTrashStack GTrashStack; -struct _GTrashStack -{ - GTrashStack *next; -}; - -G_INLINE_FUNC void g_trash_stack_push (GTrashStack **stack_p, - gpointer data_p); -G_INLINE_FUNC gpointer g_trash_stack_pop (GTrashStack **stack_p); -G_INLINE_FUNC gpointer g_trash_stack_peek (GTrashStack **stack_p); -G_INLINE_FUNC guint g_trash_stack_height (GTrashStack **stack_p); - /* inline function implementations */ #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__) @@ -358,9 +305,9 @@ g_bit_storage (gulong number) { #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__) return G_LIKELY (number) ? - ((GLIB_SIZEOF_LONG * 8U - 1) ^ __builtin_clzl(number)) + 1 : 1; + ((GLIB_SIZEOF_LONG * 8U - 1) ^ (guint) __builtin_clzl(number)) + 1 : 1; #else - register guint n_bits = 0; + guint n_bits = 0; do { @@ -371,76 +318,8 @@ g_bit_storage (gulong number) return n_bits; #endif } -G_INLINE_FUNC void -g_trash_stack_push (GTrashStack **stack_p, - gpointer data_p) -{ - GTrashStack *data = (GTrashStack *) data_p; - - data->next = *stack_p; - *stack_p = data; -} -G_INLINE_FUNC gpointer -g_trash_stack_pop (GTrashStack **stack_p) -{ - GTrashStack *data; - - data = *stack_p; - if (data) - { - *stack_p = data->next; - /* NULLify private pointer here, most platforms store NULL as - * subsequent 0 bytes - */ - data->next = NULL; - } - - return data; -} -G_INLINE_FUNC gpointer -g_trash_stack_peek (GTrashStack **stack_p) -{ - GTrashStack *data; - - data = *stack_p; - - return data; -} -G_INLINE_FUNC guint -g_trash_stack_height (GTrashStack **stack_p) -{ - GTrashStack *data; - guint i = 0; - - for (data = *stack_p; data; data = data->next) - i++; - - return i; -} #endif /* G_CAN_INLINE || __G_UTILS_C__ */ -/* Glib version. - * we prefix variable declarations so they can - * properly get exported in windows dlls. - */ -GLIB_VAR const guint glib_major_version; -GLIB_VAR const guint glib_minor_version; -GLIB_VAR const guint glib_micro_version; -GLIB_VAR const guint glib_interface_age; -GLIB_VAR const guint glib_binary_age; - -const gchar * glib_check_version (guint required_major, - guint required_minor, - guint required_micro); - -#define GLIB_CHECK_VERSION(major,minor,micro) \ - (GLIB_MAJOR_VERSION > (major) || \ - (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \ - (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \ - GLIB_MICRO_VERSION >= (micro))) - -G_END_DECLS - #ifndef G_DISABLE_DEPRECATED /* @@ -490,4 +369,6 @@ DllMain (HINSTANCE hinstDLL, \ #endif /* G_PLATFORM_WIN32 */ +G_END_DECLS + #endif /* __G_UTILS_H__ */