glib/gutils.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_UTILS_H__
  28 #define __G_UTILS_H__
  29
  30 #include <glib/gtypes.h>
  31 #include <stdarg.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #ifdef G_OS_WIN32
  36
  37 /* On Win32, the canonical directory separator is the backslash, and
  38  * the search path separator is the semicolon. Note that also the
  39  * (forward) slash works as directory separator.
  40  */
  41 #define G_DIR_SEPARATOR '\\'
  42 #define G_DIR_SEPARATOR_S "\\"
  43 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
  44 #define G_SEARCHPATH_SEPARATOR ';'
  45 #define G_SEARCHPATH_SEPARATOR_S ";"
  46
  47 #else  /* !G_OS_WIN32 */
  48
  49 /* Unix */
  50
  51 #define G_DIR_SEPARATOR '/'
  52 #define G_DIR_SEPARATOR_S "/"
  53 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
  54 #define G_SEARCHPATH_SEPARATOR ':'
  55 #define G_SEARCHPATH_SEPARATOR_S ":"
  56
  57 #endif /* !G_OS_WIN32 */
  58
  59 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
  60  * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
  61  */
  62 #if !defined (G_VA_COPY)
  63 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
  64 #    define G_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
  65 #  elif defined (G_VA_COPY_AS_ARRAY)
  66 #    define G_VA_COPY(ap1, ap2)   g_memmove ((ap1), (ap2), sizeof (va_list))
  67 #  else /* va_list is a pointer */
  68 #    define G_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
  69 #  endif /* va_list is a pointer */
  70 #endif /* !G_VA_COPY */
  71
  72 /* inlining hassle. for compilers that don't allow the `inline' keyword,
  73  * mostly because of strict ANSI C compliance or dumbness, we try to fall
  74  * back to either `__inline__' or `__inline'.
  75  * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
  76  * actually *capable* to do function inlining, in which case inline
  77  * function bodies do make sense. we also define G_INLINE_FUNC to properly
  78  * export the function prototypes if no inlining can be performed.
  79  * inline function bodies have to be special cased with G_CAN_INLINE and a
  80  * .c file specific macro to allow one compiled instance with extern linkage
  81  * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
  82  */
  83 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
  84 #  undef inline
  85 #  define inline __inline__
  86 #elif !defined (G_HAVE_INLINE)
  87 #  undef inline
  88 #  if defined (G_HAVE___INLINE__)
  89 #    define inline __inline__
  90 #  elif defined (G_HAVE___INLINE)
  91 #    define inline __inline
  92 #  else /* !inline && !__inline__ && !__inline */
  93 #    define inline  /* don't inline, then */
  94 #  endif
  95 #endif
  96 #ifdef G_IMPLEMENT_INLINES
  97 #  define G_INLINE_FUNC
  98 #  undef  G_CAN_INLINE
  99 #elif defined (__GNUC__)
 100 #  define G_INLINE_FUNC extern inline
 101 #elif defined (G_CAN_INLINE)
 102 #  define G_INLINE_FUNC static inline
 103 #else /* can't inline */
 104 #  define G_INLINE_FUNC
 105 #endif /* !G_INLINE_FUNC */
 106
 107 /* Retrive static string info
 108  */
 109 #ifdef G_OS_WIN32
 110 #define g_get_user_name g_get_user_name_utf8
 111 #define g_get_real_name g_get_real_name_utf8
 112 #define g_get_home_dir g_get_home_dir_utf8
 113 #define g_get_tmp_dir g_get_tmp_dir_utf8
 114 #endif
 115
 116 G_CONST_RETURN gchar* g_get_user_name        (void);
 117 G_CONST_RETURN gchar* g_get_real_name        (void);
 118 G_CONST_RETURN gchar* g_get_home_dir         (void);
 119 G_CONST_RETURN gchar* g_get_tmp_dir          (void);
 120 G_CONST_RETURN gchar* g_get_host_name        (void);
 121 gchar*                g_get_prgname          (void);
 122 void                  g_set_prgname          (const gchar *prgname);
 123 G_CONST_RETURN gchar* g_get_application_name (void);
 124 void                  g_set_application_name (const gchar *application_name);
 125
 126 G_CONST_RETURN gchar*    g_get_user_data_dir      (void);
 127 G_CONST_RETURN gchar*    g_get_user_config_dir    (void);
 128 G_CONST_RETURN gchar*    g_get_user_cache_dir     (void);
 129 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs   (void);
 130
 131 #ifdef G_OS_WIN32
 132 G_CONST_RETURN gchar* G_CONST_RETURN * g_win32_get_system_data_dirs_for_module (gconstpointer address);
 133 #endif
 134
 135 #if defined (G_OS_WIN32) && defined (G_CAN_INLINE) && !defined (__cplusplus)
 136 static inline G_CONST_RETURN gchar * G_CONST_RETURN *
 137 g_win32_get_system_data_dirs (void)
 138 {
 139   return g_win32_get_system_data_dirs_for_module ((gconstpointer) &g_win32_get_system_data_dirs);
 140 }
 141 #define g_get_system_data_dirs g_win32_get_system_data_dirs
 142 #endif
 143
 144 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void);
 145
 146 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void);
 147
 148 typedef struct _GDebugKey       GDebugKey;
 149 struct _GDebugKey
 150 {
 151   gchar *key;
 152   guint  value;
 153 };
 154
 155 /* Miscellaneous utility functions
 156  */
 157 guint                 g_parse_debug_string (const gchar     *string,
 158                                             const GDebugKey *keys,
 159                                             guint            nkeys);
 160
 161 gint                  g_snprintf           (gchar       *string,
 162                                             gulong       n,
 163                                             gchar const *format,
 164                                             ...) G_GNUC_PRINTF (3, 4);
 165 gint                  g_vsnprintf          (gchar       *string,
 166                                             gulong       n,
 167                                             gchar const *format,
 168                                             va_list      args);
 169
 170 /* Check if a file name is an absolute path */
 171 gboolean              g_path_is_absolute   (const gchar *file_name);
 172
 173 /* In case of absolute paths, skip the root part */
 174 G_CONST_RETURN gchar* g_path_skip_root     (const gchar *file_name);
 175
 176 #ifndef G_DISABLE_DEPRECATED
 177
 178 /* These two functions are deprecated and will be removed in the next
 179  * major release of GLib. Use g_path_get_dirname/g_path_get_basename
 180  * instead. Whatch out! The string returned by g_path_get_basename
 181  * must be g_freed, while the string returned by g_basename must not.*/
 182 G_CONST_RETURN gchar* g_basename           (const gchar *file_name);
 183 #define g_dirname g_path_get_dirname
 184
 185 #endif /* G_DISABLE_DEPRECATED */
 186
 187 #ifdef G_OS_WIN32
 188 #define g_get_current_dir g_get_current_dir_utf8
 189 #endif
 190
 191 /* The returned strings are newly allocated with g_malloc() */
 192 gchar*                g_get_current_dir    (void);
 193 gchar*                g_path_get_basename  (const gchar *file_name) G_GNUC_MALLOC;
 194 gchar*                g_path_get_dirname   (const gchar *file_name) G_GNUC_MALLOC;
 195
 196 /* Set the pointer at the specified location to NULL */
 197 void                  g_nullify_pointer    (gpointer    *nullify_location);
 198
 199 /* return the environment string for the variable. The returned memory
 200  * must not be freed. */
 201 #ifdef G_OS_WIN32
 202 #define g_getenv g_getenv_utf8
 203 #define g_setenv g_setenv_utf8
 204 #define g_unsetenv g_unsetenv_utf8
 205 #define g_find_program_in_path g_find_program_in_path_utf8
 206 #endif
 207
 208 G_CONST_RETURN gchar* g_getenv             (const gchar *variable);
 209 gboolean              g_setenv             (const gchar *variable,
 210                                             const gchar *value,
 211                                             gboolean     overwrite);
 212 void                  g_unsetenv           (const gchar *variable);
 213 gchar**               g_listenv            (void);
 214
 215 /* private */
 216 const gchar*         _g_getenv_nomalloc    (const gchar *variable,
 217                                             gchar        buffer[1024]);
 218
 219 /* we try to provide a useful equivalent for ATEXIT if it is
 220  * not defined, but use is actually abandoned. people should
 221  * use g_atexit() instead.
 222  */
 223 typedef void            (*GVoidFunc)            (void);
 224 #ifndef ATEXIT
 225 # define ATEXIT(proc)   g_ATEXIT(proc)
 226 #else
 227 # define G_NATIVE_ATEXIT
 228 #endif /* ATEXIT */
 229 /* we use a GLib function as a replacement for ATEXIT, so
 230  * the programmer is not required to check the return value
 231  * (if there is any in the implementation) and doesn't encounter
 232  * missing include files.
 233  */
 234 void    g_atexit                (GVoidFunc    func);
 235
 236 #ifdef G_OS_WIN32
 237 /* It's a bad idea to wrap atexit() on Windows. If the GLib DLL calls
 238  * atexit(), the function will be called when the GLib DLL is detached
 239  * from the program, which is not what the caller wants. The caller
 240  * wants the function to be called when it *itself* exits (or is
 241  * detached, in case the caller, too, is a DLL).
 242  */
 243 int atexit (void (*)(void));
 244 #define g_atexit(func) atexit(func)
 245 #endif
 246
 247 /* Look for an executable in PATH, following execvp() rules */
 248 gchar*  g_find_program_in_path  (const gchar *program);
 249
 250 /* Bit tests
 251  */
 252 G_INLINE_FUNC gint      g_bit_nth_lsf (gulong  mask,
 253                                        gint    nth_bit) G_GNUC_CONST;
 254 G_INLINE_FUNC gint      g_bit_nth_msf (gulong  mask,
 255                                        gint    nth_bit) G_GNUC_CONST;
 256 G_INLINE_FUNC guint     g_bit_storage (gulong  number) G_GNUC_CONST;
 257
 258 /* Trash Stacks
 259  * elements need to be >= sizeof (gpointer)
 260  */
 261 typedef struct _GTrashStack     GTrashStack;
 262 struct _GTrashStack
 263 {
 264   GTrashStack *next;
 265 };
 266
 267 G_INLINE_FUNC void      g_trash_stack_push      (GTrashStack **stack_p,
 268                                                  gpointer      data_p);
 269 G_INLINE_FUNC gpointer  g_trash_stack_pop       (GTrashStack **stack_p);
 270 G_INLINE_FUNC gpointer  g_trash_stack_peek      (GTrashStack **stack_p);
 271 G_INLINE_FUNC guint     g_trash_stack_height    (GTrashStack **stack_p);
 272
 273 /* inline function implementations
 274  */
 275 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 276 G_INLINE_FUNC gint
 277 g_bit_nth_lsf (gulong mask,
 278                gint   nth_bit)
 279 {
 280   if (G_UNLIKELY (nth_bit < -1))
 281     nth_bit = -1;
 282   while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1))
 283     {
 284       nth_bit++;
 285       if (mask & (1UL << nth_bit))
 286         return nth_bit;
 287     }
 288   return -1;
 289 }
 290 G_INLINE_FUNC gint
 291 g_bit_nth_msf (gulong mask,
 292                gint   nth_bit)
 293 {
 294   if (nth_bit < 0 || G_UNLIKELY (nth_bit > GLIB_SIZEOF_LONG * 8))
 295     nth_bit = GLIB_SIZEOF_LONG * 8;
 296   while (nth_bit > 0)
 297     {
 298       nth_bit--;
 299       if (mask & (1UL << nth_bit))
 300         return nth_bit;
 301     }
 302   return -1;
 303 }
 304 G_INLINE_FUNC guint
 305 g_bit_storage (gulong number)
 306 {
 307 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 308   return number ? GLIB_SIZEOF_LONG * 8 - __builtin_clzl(number) : 1;
 309 #else
 310   register guint n_bits = 0;
 311
 312   do
 313     {
 314       n_bits++;
 315       number >>= 1;
 316     }
 317   while (number);
 318   return n_bits;
 319 #endif
 320 }
 321 G_INLINE_FUNC void
 322 g_trash_stack_push (GTrashStack **stack_p,
 323                     gpointer      data_p)
 324 {
 325   GTrashStack *data = (GTrashStack *) data_p;
 326
 327   data->next = *stack_p;
 328   *stack_p = data;
 329 }
 330 G_INLINE_FUNC gpointer
 331 g_trash_stack_pop (GTrashStack **stack_p)
 332 {
 333   GTrashStack *data;
 334
 335   data = *stack_p;
 336   if (data)
 337     {
 338       *stack_p = data->next;
 339       /* NULLify private pointer here, most platforms store NULL as
 340        * subsequent 0 bytes
 341        */
 342       data->next = NULL;
 343     }
 344
 345   return data;
 346 }
 347 G_INLINE_FUNC gpointer
 348 g_trash_stack_peek (GTrashStack **stack_p)
 349 {
 350   GTrashStack *data;
 351
 352   data = *stack_p;
 353
 354   return data;
 355 }
 356 G_INLINE_FUNC guint
 357 g_trash_stack_height (GTrashStack **stack_p)
 358 {
 359   GTrashStack *data;
 360   guint i = 0;
 361
 362   for (data = *stack_p; data; data = data->next)
 363     i++;
 364
 365   return i;
 366 }
 367 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 368
 369 /* Glib version.
 370  * we prefix variable declarations so they can
 371  * properly get exported in windows dlls.
 372  */
 373 GLIB_VAR const guint glib_major_version;
 374 GLIB_VAR const guint glib_minor_version;
 375 GLIB_VAR const guint glib_micro_version;
 376 GLIB_VAR const guint glib_interface_age;
 377 GLIB_VAR const guint glib_binary_age;
 378
 379 const gchar * glib_check_version (guint required_major,
 380                                   guint required_minor,
 381                                   guint required_micro);
 382
 383 #define GLIB_CHECK_VERSION(major,minor,micro)    \
 384     (GLIB_MAJOR_VERSION > (major) || \
 385      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 386      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
 387       GLIB_MICRO_VERSION >= (micro)))
 388
 389 G_END_DECLS
 390
 391 /*
 392  * On Windows, this macro defines a DllMain function that stores the
 393  * actual DLL name that the code being compiled will be included in.
 394  * STATIC should be empty or 'static'. DLL_NAME is the name of the
 395  * (pointer to the) char array where the DLL name will be stored. If
 396  * this is used, you must also include <windows.h>. If you need a more complex
 397  * DLL entry point function, you cannot use this.
 398  *
 399  * On non-Windows platforms, expands to nothing.
 400  */
 401
 402 #ifndef G_PLATFORM_WIN32
 403 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
 404 #else
 405 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)                 \
 406 static char *dll_name;                                                  \
 407                                                                         \
 408 BOOL WINAPI                                                             \
 409 DllMain (HINSTANCE hinstDLL,                                            \
 410          DWORD     fdwReason,                                           \
 411          LPVOID    lpvReserved)                                         \
 412 {                                                                       \
 413   wchar_t wcbfr[1000];                                                  \
 414   char *tem;                                                            \
 415   switch (fdwReason)                                                    \
 416     {                                                                   \
 417     case DLL_PROCESS_ATTACH:                                            \
 418       GetModuleFileNameW ((HMODULE) hinstDLL, wcbfr, G_N_ELEMENTS (wcbfr)); \
 419       tem = g_utf16_to_utf8 (wcbfr, -1, NULL, NULL, NULL);              \
 420       dll_name = g_path_get_basename (tem);                             \
 421       g_free (tem);                                                     \
 422       break;                                                            \
 423     }                                                                   \
 424                                                                         \
 425   return TRUE;                                                          \
 426 }
 427 #endif /* G_PLATFORM_WIN32 */
 428
 429 #endif /* __G_UTILS_H__ */