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 static __inline __attribute__ ((unused))
 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 /**
 149  * GUserDirectory:
 150  * @G_USER_DIRECTORY_DESKTOP: the user's Desktop directory
 151  * @G_USER_DIRECTORY_DOCUMENTS: the user's Documents directory
 152  * @G_USER_DIRECTORY_DOWNLOAD: the user's Downloads directory
 153  * @G_USER_DIRECTORY_MUSIC: the user's Music directory
 154  * @G_USER_DIRECTORY_PICTURES: the user's Pictures directory
 155  * @G_USER_DIRECTORY_PUBLIC_SHARE: the user's shared directory
 156  * @G_USER_DIRECTORY_TEMPLATES: the user's Templates directory
 157  * @G_USER_DIRECTORY_VIDEOS: the user's Movies directory
 158  * @G_USER_N_DIRECTORIES: the number of enum values
 159  *
 160  * These are logical ids for special directories which are defined
 161  * depending on the platform used. You should use g_get_user_special_dir()
 162  * to retrieve the full path associated to the logical id.
 163  *
 164  * The #GUserDirectory enumeration can be extended at later date. Not
 165  * every platform has a directory for every logical id in this
 166  * enumeration.
 167  *
 168  * Since: 2.14
 169  */
 170 typedef enum {
 171   G_USER_DIRECTORY_DESKTOP,
 172   G_USER_DIRECTORY_DOCUMENTS,
 173   G_USER_DIRECTORY_DOWNLOAD,
 174   G_USER_DIRECTORY_MUSIC,
 175   G_USER_DIRECTORY_PICTURES,
 176   G_USER_DIRECTORY_PUBLIC_SHARE,
 177   G_USER_DIRECTORY_TEMPLATES,
 178   G_USER_DIRECTORY_VIDEOS,
 179
 180   G_USER_N_DIRECTORIES
 181 } GUserDirectory;
 182
 183 G_CONST_RETURN gchar* g_get_user_special_dir (GUserDirectory directory);
 184
 185 typedef struct _GDebugKey       GDebugKey;
 186 struct _GDebugKey
 187 {
 188   gchar *key;
 189   guint  value;
 190 };
 191
 192 /* Miscellaneous utility functions
 193  */
 194 guint                 g_parse_debug_string (const gchar     *string,
 195                                             const GDebugKey *keys,
 196                                             guint            nkeys);
 197
 198 gint                  g_snprintf           (gchar       *string,
 199                                             gulong       n,
 200                                             gchar const *format,
 201                                             ...) G_GNUC_PRINTF (3, 4);
 202 gint                  g_vsnprintf          (gchar       *string,
 203                                             gulong       n,
 204                                             gchar const *format,
 205                                             va_list      args);
 206
 207 /* Check if a file name is an absolute path */
 208 gboolean              g_path_is_absolute   (const gchar *file_name);
 209
 210 /* In case of absolute paths, skip the root part */
 211 G_CONST_RETURN gchar* g_path_skip_root     (const gchar *file_name);
 212
 213 #ifndef G_DISABLE_DEPRECATED
 214
 215 /* These two functions are deprecated and will be removed in the next
 216  * major release of GLib. Use g_path_get_dirname/g_path_get_basename
 217  * instead. Whatch out! The string returned by g_path_get_basename
 218  * must be g_freed, while the string returned by g_basename must not.*/
 219 G_CONST_RETURN gchar* g_basename           (const gchar *file_name);
 220 #define g_dirname g_path_get_dirname
 221
 222 #endif /* G_DISABLE_DEPRECATED */
 223
 224 #ifdef G_OS_WIN32
 225 #define g_get_current_dir g_get_current_dir_utf8
 226 #endif
 227
 228 /* The returned strings are newly allocated with g_malloc() */
 229 gchar*                g_get_current_dir    (void);
 230 gchar*                g_path_get_basename  (const gchar *file_name) G_GNUC_MALLOC;
 231 gchar*                g_path_get_dirname   (const gchar *file_name) G_GNUC_MALLOC;
 232
 233 /* Set the pointer at the specified location to NULL */
 234 void                  g_nullify_pointer    (gpointer    *nullify_location);
 235
 236 /* return the environment string for the variable. The returned memory
 237  * must not be freed. */
 238 #ifdef G_OS_WIN32
 239 #define g_getenv g_getenv_utf8
 240 #define g_setenv g_setenv_utf8
 241 #define g_unsetenv g_unsetenv_utf8
 242 #define g_find_program_in_path g_find_program_in_path_utf8
 243 #endif
 244
 245 G_CONST_RETURN gchar* g_getenv             (const gchar *variable);
 246 gboolean              g_setenv             (const gchar *variable,
 247                                             const gchar *value,
 248                                             gboolean     overwrite);
 249 void                  g_unsetenv           (const gchar *variable);
 250 gchar**               g_listenv            (void);
 251
 252 /* private */
 253 const gchar*         _g_getenv_nomalloc    (const gchar *variable,
 254                                             gchar        buffer[1024]);
 255
 256 /* we try to provide a useful equivalent for ATEXIT if it is
 257  * not defined, but use is actually abandoned. people should
 258  * use g_atexit() instead.
 259  */
 260 typedef void            (*GVoidFunc)            (void);
 261 #ifndef ATEXIT
 262 # define ATEXIT(proc)   g_ATEXIT(proc)
 263 #else
 264 # define G_NATIVE_ATEXIT
 265 #endif /* ATEXIT */
 266 /* we use a GLib function as a replacement for ATEXIT, so
 267  * the programmer is not required to check the return value
 268  * (if there is any in the implementation) and doesn't encounter
 269  * missing include files.
 270  */
 271 void    g_atexit                (GVoidFunc    func);
 272
 273 #ifdef G_OS_WIN32
 274 /* It's a bad idea to wrap atexit() on Windows. If the GLib DLL calls
 275  * atexit(), the function will be called when the GLib DLL is detached
 276  * from the program, which is not what the caller wants. The caller
 277  * wants the function to be called when it *itself* exits (or is
 278  * detached, in case the caller, too, is a DLL).
 279  */
 280 int atexit (void (*)(void));
 281 #define g_atexit(func) atexit(func)
 282 #endif
 283
 284 /* Look for an executable in PATH, following execvp() rules */
 285 gchar*  g_find_program_in_path  (const gchar *program);
 286
 287 /* Bit tests
 288  */
 289 G_INLINE_FUNC gint      g_bit_nth_lsf (gulong  mask,
 290                                        gint    nth_bit) G_GNUC_CONST;
 291 G_INLINE_FUNC gint      g_bit_nth_msf (gulong  mask,
 292                                        gint    nth_bit) G_GNUC_CONST;
 293 G_INLINE_FUNC guint     g_bit_storage (gulong  number) G_GNUC_CONST;
 294
 295 /* Trash Stacks
 296  * elements need to be >= sizeof (gpointer)
 297  */
 298 typedef struct _GTrashStack     GTrashStack;
 299 struct _GTrashStack
 300 {
 301   GTrashStack *next;
 302 };
 303
 304 G_INLINE_FUNC void      g_trash_stack_push      (GTrashStack **stack_p,
 305                                                  gpointer      data_p);
 306 G_INLINE_FUNC gpointer  g_trash_stack_pop       (GTrashStack **stack_p);
 307 G_INLINE_FUNC gpointer  g_trash_stack_peek      (GTrashStack **stack_p);
 308 G_INLINE_FUNC guint     g_trash_stack_height    (GTrashStack **stack_p);
 309
 310 /* inline function implementations
 311  */
 312 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 313 G_INLINE_FUNC gint
 314 g_bit_nth_lsf (gulong mask,
 315                gint   nth_bit)
 316 {
 317   if (G_UNLIKELY (nth_bit < -1))
 318     nth_bit = -1;
 319   while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1))
 320     {
 321       nth_bit++;
 322       if (mask & (1UL << nth_bit))
 323         return nth_bit;
 324     }
 325   return -1;
 326 }
 327 G_INLINE_FUNC gint
 328 g_bit_nth_msf (gulong mask,
 329                gint   nth_bit)
 330 {
 331   if (nth_bit < 0 || G_UNLIKELY (nth_bit > GLIB_SIZEOF_LONG * 8))
 332     nth_bit = GLIB_SIZEOF_LONG * 8;
 333   while (nth_bit > 0)
 334     {
 335       nth_bit--;
 336       if (mask & (1UL << nth_bit))
 337         return nth_bit;
 338     }
 339   return -1;
 340 }
 341 G_INLINE_FUNC guint
 342 g_bit_storage (gulong number)
 343 {
 344 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 345   return G_LIKELY (number) ?
 346            ((GLIB_SIZEOF_LONG * 8 - 1) ^ __builtin_clzl(number)) + 1 : 1;
 347 #else
 348   register guint n_bits = 0;
 349
 350   do
 351     {
 352       n_bits++;
 353       number >>= 1;
 354     }
 355   while (number);
 356   return n_bits;
 357 #endif
 358 }
 359 G_INLINE_FUNC void
 360 g_trash_stack_push (GTrashStack **stack_p,
 361                     gpointer      data_p)
 362 {
 363   GTrashStack *data = (GTrashStack *) data_p;
 364
 365   data->next = *stack_p;
 366   *stack_p = data;
 367 }
 368 G_INLINE_FUNC gpointer
 369 g_trash_stack_pop (GTrashStack **stack_p)
 370 {
 371   GTrashStack *data;
 372
 373   data = *stack_p;
 374   if (data)
 375     {
 376       *stack_p = data->next;
 377       /* NULLify private pointer here, most platforms store NULL as
 378        * subsequent 0 bytes
 379        */
 380       data->next = NULL;
 381     }
 382
 383   return data;
 384 }
 385 G_INLINE_FUNC gpointer
 386 g_trash_stack_peek (GTrashStack **stack_p)
 387 {
 388   GTrashStack *data;
 389
 390   data = *stack_p;
 391
 392   return data;
 393 }
 394 G_INLINE_FUNC guint
 395 g_trash_stack_height (GTrashStack **stack_p)
 396 {
 397   GTrashStack *data;
 398   guint i = 0;
 399
 400   for (data = *stack_p; data; data = data->next)
 401     i++;
 402
 403   return i;
 404 }
 405 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 406
 407 /* Glib version.
 408  * we prefix variable declarations so they can
 409  * properly get exported in windows dlls.
 410  */
 411 GLIB_VAR const guint glib_major_version;
 412 GLIB_VAR const guint glib_minor_version;
 413 GLIB_VAR const guint glib_micro_version;
 414 GLIB_VAR const guint glib_interface_age;
 415 GLIB_VAR const guint glib_binary_age;
 416
 417 const gchar * glib_check_version (guint required_major,
 418                                   guint required_minor,
 419                                   guint required_micro);
 420
 421 #define GLIB_CHECK_VERSION(major,minor,micro)    \
 422     (GLIB_MAJOR_VERSION > (major) || \
 423      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 424      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
 425       GLIB_MICRO_VERSION >= (micro)))
 426
 427 G_END_DECLS
 428
 429 /*
 430  * On Windows, this macro defines a DllMain function that stores the
 431  * actual DLL name that the code being compiled will be included in.
 432  * STATIC should be empty or 'static'. DLL_NAME is the name of the
 433  * (pointer to the) char array where the DLL name will be stored. If
 434  * this is used, you must also include <windows.h>. If you need a more complex
 435  * DLL entry point function, you cannot use this.
 436  *
 437  * On non-Windows platforms, expands to nothing.
 438  */
 439
 440 #ifndef G_PLATFORM_WIN32
 441 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
 442 #else
 443 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)                 \
 444 static char *dll_name;                                                  \
 445                                                                         \
 446 BOOL WINAPI                                                             \
 447 DllMain (HINSTANCE hinstDLL,                                            \
 448          DWORD     fdwReason,                                           \
 449          LPVOID    lpvReserved)                                         \
 450 {                                                                       \
 451   wchar_t wcbfr[1000];                                                  \
 452   char *tem;                                                            \
 453   switch (fdwReason)                                                    \
 454     {                                                                   \
 455     case DLL_PROCESS_ATTACH:                                            \
 456       GetModuleFileNameW ((HMODULE) hinstDLL, wcbfr, G_N_ELEMENTS (wcbfr)); \
 457       tem = g_utf16_to_utf8 (wcbfr, -1, NULL, NULL, NULL);              \
 458       dll_name = g_path_get_basename (tem);                             \
 459       g_free (tem);                                                     \
 460       break;                                                            \
 461     }                                                                   \
 462                                                                         \
 463   return TRUE;                                                          \
 464 }
 465 #endif /* G_PLATFORM_WIN32 */
 466
 467 #endif /* __G_UTILS_H__ */