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 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_UTILS_H__
  32 #define __G_UTILS_H__
  33
  34 #include <glib/gtypes.h>
  35 #include <stdarg.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #ifdef G_OS_WIN32
  40
  41 /* On Win32, the canonical directory separator is the backslash, and
  42  * the search path separator is the semicolon. Note that also the
  43  * (forward) slash works as directory separator.
  44  */
  45 #define G_DIR_SEPARATOR '\\'
  46 #define G_DIR_SEPARATOR_S "\\"
  47 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
  48 #define G_SEARCHPATH_SEPARATOR ';'
  49 #define G_SEARCHPATH_SEPARATOR_S ";"
  50
  51 #else  /* !G_OS_WIN32 */
  52
  53 /* Unix */
  54
  55 #define G_DIR_SEPARATOR '/'
  56 #define G_DIR_SEPARATOR_S "/"
  57 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
  58 #define G_SEARCHPATH_SEPARATOR ':'
  59 #define G_SEARCHPATH_SEPARATOR_S ":"
  60
  61 #endif /* !G_OS_WIN32 */
  62
  63 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
  64  * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
  65  */
  66 #if !defined (G_VA_COPY)
  67 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
  68 #    define G_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
  69 #  elif defined (G_VA_COPY_AS_ARRAY)
  70 #    define G_VA_COPY(ap1, ap2)   g_memmove ((ap1), (ap2), sizeof (va_list))
  71 #  else /* va_list is a pointer */
  72 #    define G_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
  73 #  endif /* va_list is a pointer */
  74 #endif /* !G_VA_COPY */
  75
  76 /* inlining hassle. for compilers that don't allow the `inline' keyword,
  77  * mostly because of strict ANSI C compliance or dumbness, we try to fall
  78  * back to either `__inline__' or `__inline'.
  79  * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
  80  * actually *capable* to do function inlining, in which case inline
  81  * function bodies do make sense. we also define G_INLINE_FUNC to properly
  82  * export the function prototypes if no inlining can be performed.
  83  * inline function bodies have to be special cased with G_CAN_INLINE and a
  84  * .c file specific macro to allow one compiled instance with extern linkage
  85  * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
  86  */
  87 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
  88 #  undef inline
  89 #  define inline __inline__
  90 #elif !defined (G_HAVE_INLINE)
  91 #  undef inline
  92 #  if defined (G_HAVE___INLINE__)
  93 #    define inline __inline__
  94 #  elif defined (G_HAVE___INLINE)
  95 #    define inline __inline
  96 #  else /* !inline && !__inline__ && !__inline */
  97 #    define inline  /* don't inline, then */
  98 #  endif
  99 #endif
 100 #ifdef G_IMPLEMENT_INLINES
 101 #  define G_INLINE_FUNC
 102 #  undef  G_CAN_INLINE
 103 #elif defined (__GNUC__)
 104 #  define G_INLINE_FUNC static __inline __attribute__ ((unused))
 105 #elif defined (G_CAN_INLINE)
 106 #  define G_INLINE_FUNC static inline
 107 #else /* can't inline */
 108 #  define G_INLINE_FUNC
 109 #endif /* !G_INLINE_FUNC */
 110
 111 /* Retrive static string info
 112  */
 113 #ifdef G_OS_WIN32
 114 #define g_get_user_name g_get_user_name_utf8
 115 #define g_get_real_name g_get_real_name_utf8
 116 #define g_get_home_dir g_get_home_dir_utf8
 117 #define g_get_tmp_dir g_get_tmp_dir_utf8
 118 #endif
 119
 120 G_CONST_RETURN gchar* g_get_user_name        (void);
 121 G_CONST_RETURN gchar* g_get_real_name        (void);
 122 G_CONST_RETURN gchar* g_get_home_dir         (void);
 123 G_CONST_RETURN gchar* g_get_tmp_dir          (void);
 124 G_CONST_RETURN gchar* g_get_host_name        (void);
 125 gchar*                g_get_prgname          (void);
 126 void                  g_set_prgname          (const gchar *prgname);
 127 G_CONST_RETURN gchar* g_get_application_name (void);
 128 void                  g_set_application_name (const gchar *application_name);
 129
 130 void    g_reload_user_special_dirs_cache     (void);
 131 G_CONST_RETURN gchar*    g_get_user_data_dir      (void);
 132 G_CONST_RETURN gchar*    g_get_user_config_dir    (void);
 133 G_CONST_RETURN gchar*    g_get_user_cache_dir     (void);
 134 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs   (void);
 135
 136 #ifdef G_OS_WIN32
 137 /* This functions is not part of the public GLib API */
 138 G_CONST_RETURN gchar* G_CONST_RETURN * g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void));
 139 #endif
 140
 141 #if defined (G_OS_WIN32) && defined (G_CAN_INLINE) && !defined (__cplusplus)
 142 /* This function is not part of the public GLib API either. Just call
 143  * g_get_system_data_dirs() in your code, never mind that that is
 144  * actually a macro and you will in fact call this inline function.
 145  */
 146 static inline G_CONST_RETURN gchar * G_CONST_RETURN *
 147 _g_win32_get_system_data_dirs (void)
 148 {
 149   return g_win32_get_system_data_dirs_for_module ((void (*)(void)) &_g_win32_get_system_data_dirs);
 150 }
 151 #define g_get_system_data_dirs _g_win32_get_system_data_dirs
 152 #endif
 153
 154 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void);
 155
 156 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void);
 157
 158 /**
 159  * GUserDirectory:
 160  * @G_USER_DIRECTORY_DESKTOP: the user's Desktop directory
 161  * @G_USER_DIRECTORY_DOCUMENTS: the user's Documents directory
 162  * @G_USER_DIRECTORY_DOWNLOAD: the user's Downloads directory
 163  * @G_USER_DIRECTORY_MUSIC: the user's Music directory
 164  * @G_USER_DIRECTORY_PICTURES: the user's Pictures directory
 165  * @G_USER_DIRECTORY_PUBLIC_SHARE: the user's shared directory
 166  * @G_USER_DIRECTORY_TEMPLATES: the user's Templates directory
 167  * @G_USER_DIRECTORY_VIDEOS: the user's Movies directory
 168  * @G_USER_N_DIRECTORIES: the number of enum values
 169  *
 170  * These are logical ids for special directories which are defined
 171  * depending on the platform used. You should use g_get_user_special_dir()
 172  * to retrieve the full path associated to the logical id.
 173  *
 174  * The #GUserDirectory enumeration can be extended at later date. Not
 175  * every platform has a directory for every logical id in this
 176  * enumeration.
 177  *
 178  * Since: 2.14
 179  */
 180 typedef enum {
 181   G_USER_DIRECTORY_DESKTOP,
 182   G_USER_DIRECTORY_DOCUMENTS,
 183   G_USER_DIRECTORY_DOWNLOAD,
 184   G_USER_DIRECTORY_MUSIC,
 185   G_USER_DIRECTORY_PICTURES,
 186   G_USER_DIRECTORY_PUBLIC_SHARE,
 187   G_USER_DIRECTORY_TEMPLATES,
 188   G_USER_DIRECTORY_VIDEOS,
 189
 190   G_USER_N_DIRECTORIES
 191 } GUserDirectory;
 192
 193 G_CONST_RETURN gchar* g_get_user_special_dir (GUserDirectory directory);
 194
 195 typedef struct _GDebugKey       GDebugKey;
 196 struct _GDebugKey
 197 {
 198   const gchar *key;
 199   guint        value;
 200 };
 201
 202 /* Miscellaneous utility functions
 203  */
 204 guint                 g_parse_debug_string (const gchar     *string,
 205                                             const GDebugKey *keys,
 206                                             guint            nkeys);
 207
 208 gint                  g_snprintf           (gchar       *string,
 209                                             gulong       n,
 210                                             gchar const *format,
 211                                             ...) G_GNUC_PRINTF (3, 4);
 212 gint                  g_vsnprintf          (gchar       *string,
 213                                             gulong       n,
 214                                             gchar const *format,
 215                                             va_list      args);
 216
 217 /* Check if a file name is an absolute path */
 218 gboolean              g_path_is_absolute   (const gchar *file_name);
 219
 220 /* In case of absolute paths, skip the root part */
 221 G_CONST_RETURN gchar* g_path_skip_root     (const gchar *file_name);
 222
 223 #ifndef G_DISABLE_DEPRECATED
 224
 225 /* These two functions are deprecated and will be removed in the next
 226  * major release of GLib. Use g_path_get_dirname/g_path_get_basename
 227  * instead. Whatch out! The string returned by g_path_get_basename
 228  * must be g_freed, while the string returned by g_basename must not.*/
 229 G_CONST_RETURN gchar* g_basename           (const gchar *file_name);
 230 #define g_dirname g_path_get_dirname
 231
 232 #endif /* G_DISABLE_DEPRECATED */
 233
 234 #ifdef G_OS_WIN32
 235 #define g_get_current_dir g_get_current_dir_utf8
 236 #endif
 237
 238 /* The returned strings are newly allocated with g_malloc() */
 239 gchar*                g_get_current_dir    (void);
 240 gchar*                g_path_get_basename  (const gchar *file_name) G_GNUC_MALLOC;
 241 gchar*                g_path_get_dirname   (const gchar *file_name) G_GNUC_MALLOC;
 242
 243 /* Set the pointer at the specified location to NULL */
 244 void                  g_nullify_pointer    (gpointer    *nullify_location);
 245
 246 /* return the environment string for the variable. The returned memory
 247  * must not be freed. */
 248 #ifdef G_OS_WIN32
 249 #define g_getenv g_getenv_utf8
 250 #define g_setenv g_setenv_utf8
 251 #define g_unsetenv g_unsetenv_utf8
 252 #define g_find_program_in_path g_find_program_in_path_utf8
 253 #endif
 254
 255 G_CONST_RETURN gchar* g_getenv             (const gchar *variable);
 256 gboolean              g_setenv             (const gchar *variable,
 257                                             const gchar *value,
 258                                             gboolean     overwrite);
 259 void                  g_unsetenv           (const gchar *variable);
 260 gchar**               g_listenv            (void);
 261
 262 /* private */
 263 const gchar*         _g_getenv_nomalloc    (const gchar *variable,
 264                                             gchar        buffer[1024]);
 265
 266 /* we try to provide a useful equivalent for ATEXIT if it is
 267  * not defined, but use is actually abandoned. people should
 268  * use g_atexit() instead.
 269  */
 270 typedef void            (*GVoidFunc)            (void);
 271 #ifndef ATEXIT
 272 # define ATEXIT(proc)   g_ATEXIT(proc)
 273 #else
 274 # define G_NATIVE_ATEXIT
 275 #endif /* ATEXIT */
 276 /* we use a GLib function as a replacement for ATEXIT, so
 277  * the programmer is not required to check the return value
 278  * (if there is any in the implementation) and doesn't encounter
 279  * missing include files.
 280  */
 281 void    g_atexit                (GVoidFunc    func);
 282
 283 #ifdef G_OS_WIN32
 284 /* It's a bad idea to wrap atexit() on Windows. If the GLib DLL calls
 285  * atexit(), the function will be called when the GLib DLL is detached
 286  * from the program, which is not what the caller wants. The caller
 287  * wants the function to be called when it *itself* exits (or is
 288  * detached, in case the caller, too, is a DLL).
 289  */
 290 #if (defined(__MINGW_H) && !defined(_STDLIB_H_)) || (defined(_MSC_VER) && !defined(_INC_STDLIB))
 291 int atexit (void (*)(void));
 292 #endif
 293 #define g_atexit(func) atexit(func)
 294 #endif
 295
 296 /* Look for an executable in PATH, following execvp() rules */
 297 gchar*  g_find_program_in_path  (const gchar *program);
 298
 299 /* Bit tests
 300  */
 301 G_INLINE_FUNC gint      g_bit_nth_lsf (gulong  mask,
 302                                        gint    nth_bit) G_GNUC_CONST;
 303 G_INLINE_FUNC gint      g_bit_nth_msf (gulong  mask,
 304                                        gint    nth_bit) G_GNUC_CONST;
 305 G_INLINE_FUNC guint     g_bit_storage (gulong  number) G_GNUC_CONST;
 306
 307 /* Trash Stacks
 308  * elements need to be >= sizeof (gpointer)
 309  */
 310 typedef struct _GTrashStack     GTrashStack;
 311 struct _GTrashStack
 312 {
 313   GTrashStack *next;
 314 };
 315
 316 G_INLINE_FUNC void      g_trash_stack_push      (GTrashStack **stack_p,
 317                                                  gpointer      data_p);
 318 G_INLINE_FUNC gpointer  g_trash_stack_pop       (GTrashStack **stack_p);
 319 G_INLINE_FUNC gpointer  g_trash_stack_peek      (GTrashStack **stack_p);
 320 G_INLINE_FUNC guint     g_trash_stack_height    (GTrashStack **stack_p);
 321
 322 /* inline function implementations
 323  */
 324 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 325 G_INLINE_FUNC gint
 326 g_bit_nth_lsf (gulong mask,
 327                gint   nth_bit)
 328 {
 329   if (G_UNLIKELY (nth_bit < -1))
 330     nth_bit = -1;
 331   while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1))
 332     {
 333       nth_bit++;
 334       if (mask & (1UL << nth_bit))
 335         return nth_bit;
 336     }
 337   return -1;
 338 }
 339 G_INLINE_FUNC gint
 340 g_bit_nth_msf (gulong mask,
 341                gint   nth_bit)
 342 {
 343   if (nth_bit < 0 || G_UNLIKELY (nth_bit > GLIB_SIZEOF_LONG * 8))
 344     nth_bit = GLIB_SIZEOF_LONG * 8;
 345   while (nth_bit > 0)
 346     {
 347       nth_bit--;
 348       if (mask & (1UL << nth_bit))
 349         return nth_bit;
 350     }
 351   return -1;
 352 }
 353 G_INLINE_FUNC guint
 354 g_bit_storage (gulong number)
 355 {
 356 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 357   return G_LIKELY (number) ?
 358            ((GLIB_SIZEOF_LONG * 8 - 1) ^ __builtin_clzl(number)) + 1 : 1;
 359 #else
 360   register guint n_bits = 0;
 361
 362   do
 363     {
 364       n_bits++;
 365       number >>= 1;
 366     }
 367   while (number);
 368   return n_bits;
 369 #endif
 370 }
 371 G_INLINE_FUNC void
 372 g_trash_stack_push (GTrashStack **stack_p,
 373                     gpointer      data_p)
 374 {
 375   GTrashStack *data = (GTrashStack *) data_p;
 376
 377   data->next = *stack_p;
 378   *stack_p = data;
 379 }
 380 G_INLINE_FUNC gpointer
 381 g_trash_stack_pop (GTrashStack **stack_p)
 382 {
 383   GTrashStack *data;
 384
 385   data = *stack_p;
 386   if (data)
 387     {
 388       *stack_p = data->next;
 389       /* NULLify private pointer here, most platforms store NULL as
 390        * subsequent 0 bytes
 391        */
 392       data->next = NULL;
 393     }
 394
 395   return data;
 396 }
 397 G_INLINE_FUNC gpointer
 398 g_trash_stack_peek (GTrashStack **stack_p)
 399 {
 400   GTrashStack *data;
 401
 402   data = *stack_p;
 403
 404   return data;
 405 }
 406 G_INLINE_FUNC guint
 407 g_trash_stack_height (GTrashStack **stack_p)
 408 {
 409   GTrashStack *data;
 410   guint i = 0;
 411
 412   for (data = *stack_p; data; data = data->next)
 413     i++;
 414
 415   return i;
 416 }
 417 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 418
 419 /* Glib version.
 420  * we prefix variable declarations so they can
 421  * properly get exported in windows dlls.
 422  */
 423 GLIB_VAR const guint glib_major_version;
 424 GLIB_VAR const guint glib_minor_version;
 425 GLIB_VAR const guint glib_micro_version;
 426 GLIB_VAR const guint glib_interface_age;
 427 GLIB_VAR const guint glib_binary_age;
 428
 429 const gchar * glib_check_version (guint required_major,
 430                                   guint required_minor,
 431                                   guint required_micro);
 432
 433 #define GLIB_CHECK_VERSION(major,minor,micro)    \
 434     (GLIB_MAJOR_VERSION > (major) || \
 435      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 436      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
 437       GLIB_MICRO_VERSION >= (micro)))
 438
 439 G_END_DECLS
 440
 441 #ifndef G_DISABLE_DEPRECATED
 442
 443 /*
 444  * This macro is deprecated. This DllMain() is too complex. It is
 445  * recommended to write an explicit minimal DLlMain() that just saves
 446  * the handle to the DLL and then use that handle instead, for
 447  * instance passing it to
 448  * g_win32_get_package_installation_directory_of_module().
 449  *
 450  * On Windows, this macro defines a DllMain function that stores the
 451  * actual DLL name that the code being compiled will be included in.
 452  * STATIC should be empty or 'static'. DLL_NAME is the name of the
 453  * (pointer to the) char array where the DLL name will be stored. If
 454  * this is used, you must also include <windows.h>. If you need a more complex
 455  * DLL entry point function, you cannot use this.
 456  *
 457  * On non-Windows platforms, expands to nothing.
 458  */
 459
 460 #ifndef G_PLATFORM_WIN32
 461 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
 462 #else
 463 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)                 \
 464 static char *dll_name;                                                  \
 465                                                                         \
 466 BOOL WINAPI                                                             \
 467 DllMain (HINSTANCE hinstDLL,                                            \
 468          DWORD     fdwReason,                                           \
 469          LPVOID    lpvReserved)                                         \
 470 {                                                                       \
 471   wchar_t wcbfr[1000];                                                  \
 472   char *tem;                                                            \
 473   switch (fdwReason)                                                    \
 474     {                                                                   \
 475     case DLL_PROCESS_ATTACH:                                            \
 476       GetModuleFileNameW ((HMODULE) hinstDLL, wcbfr, G_N_ELEMENTS (wcbfr)); \
 477       tem = g_utf16_to_utf8 (wcbfr, -1, NULL, NULL, NULL);              \
 478       dll_name = g_path_get_basename (tem);                             \
 479       g_free (tem);                                                     \
 480       break;                                                            \
 481     }                                                                   \
 482                                                                         \
 483   return TRUE;                                                          \
 484 }
 485
 486 #endif  /* !G_DISABLE_DEPRECATED */
 487
 488 #endif /* G_PLATFORM_WIN32 */
 489
 490 #endif /* __G_UTILS_H__ */