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 native Win32, directory separator is the backslash, and search path
  38  * separator is the semicolon.
  39  */
  40 #define G_DIR_SEPARATOR '\\'
  41 #define G_DIR_SEPARATOR_S "\\"
  42 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
  43 #define G_SEARCHPATH_SEPARATOR ';'
  44 #define G_SEARCHPATH_SEPARATOR_S ";"
  45
  46 #else  /* !G_OS_WIN32 */
  47
  48 /* Unix */
  49
  50 #define G_DIR_SEPARATOR '/'
  51 #define G_DIR_SEPARATOR_S "/"
  52 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
  53 #define G_SEARCHPATH_SEPARATOR ':'
  54 #define G_SEARCHPATH_SEPARATOR_S ":"
  55
  56 #endif /* !G_OS_WIN32 */
  57
  58 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
  59  * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
  60  */
  61 #if !defined (G_VA_COPY)
  62 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
  63 #    define G_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
  64 #  elif defined (G_VA_COPY_AS_ARRAY)
  65 #    define G_VA_COPY(ap1, ap2)   g_memmove ((ap1), (ap2), sizeof (va_list))
  66 #  else /* va_list is a pointer */
  67 #    define G_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
  68 #  endif /* va_list is a pointer */
  69 #endif /* !G_VA_COPY */
  70
  71 /* inlining hassle. for compilers that don't allow the `inline' keyword,
  72  * mostly because of strict ANSI C compliance or dumbness, we try to fall
  73  * back to either `__inline__' or `__inline'.
  74  * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
  75  * actually *capable* to do function inlining, in which case inline
  76  * function bodies do make sense. we also define G_INLINE_FUNC to properly
  77  * export the function prototypes if no inlining can be performed.
  78  * inline function bodies have to be special cased with G_CAN_INLINE and a
  79  * .c file specific macro to allow one compiled instance with extern linkage
  80  * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
  81  */
  82 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
  83 #  undef inline
  84 #  define inline __inline__
  85 #elif !defined (G_HAVE_INLINE)
  86 #  undef inline
  87 #  if defined (G_HAVE___INLINE__)
  88 #    define inline __inline__
  89 #  elif defined (G_HAVE___INLINE)
  90 #    define inline __inline
  91 #  else /* !inline && !__inline__ && !__inline */
  92 #    define inline  /* don't inline, then */
  93 #  endif
  94 #endif
  95 #ifdef G_IMPLEMENT_INLINES
  96 #  define G_INLINE_FUNC
  97 #  undef  G_CAN_INLINE
  98 #elif defined (__GNUC__)
  99 #  define G_INLINE_FUNC extern inline
 100 #elif defined (G_CAN_INLINE)
 101 #  define G_INLINE_FUNC static inline
 102 #else /* can't inline */
 103 #  define G_INLINE_FUNC
 104 #endif /* !G_INLINE_FUNC */
 105
 106 /* Retrive static string info
 107  */
 108 #ifdef G_OS_WIN32
 109 #define g_get_user_name g_get_user_name_utf8
 110 #define g_get_real_name g_get_real_name_utf8
 111 #define g_get_home_dir g_get_home_dir_utf8
 112 #define g_get_tmp_dir g_get_tmp_dir_utf8
 113 #endif
 114
 115 G_CONST_RETURN gchar* g_get_user_name        (void);
 116 G_CONST_RETURN gchar* g_get_real_name        (void);
 117 G_CONST_RETURN gchar* g_get_home_dir         (void);
 118 G_CONST_RETURN gchar* g_get_tmp_dir          (void);
 119 gchar*                g_get_prgname          (void);
 120 void                  g_set_prgname          (const gchar *prgname);
 121 G_CONST_RETURN gchar* g_get_application_name (void);
 122 void                  g_set_application_name (const gchar *application_name);
 123
 124 G_CONST_RETURN gchar*    g_get_user_data_dir      (void);
 125 G_CONST_RETURN gchar*    g_get_user_config_dir    (void);
 126 G_CONST_RETURN gchar*    g_get_user_cache_dir     (void);
 127 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_data_dirs   (void);
 128 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_system_config_dirs (void);
 129
 130 G_CONST_RETURN gchar* G_CONST_RETURN * g_get_language_names (void);
 131
 132 typedef struct _GDebugKey       GDebugKey;
 133 struct _GDebugKey
 134 {
 135   gchar *key;
 136   guint  value;
 137 };
 138
 139 /* Miscellaneous utility functions
 140  */
 141 guint                 g_parse_debug_string (const gchar     *string,
 142                                             const GDebugKey *keys,
 143                                             guint            nkeys);
 144
 145 gint                  g_snprintf           (gchar       *string,
 146                                             gulong       n,
 147                                             gchar const *format,
 148                                             ...) G_GNUC_PRINTF (3, 4);
 149 gint                  g_vsnprintf          (gchar       *string,
 150                                             gulong       n,
 151                                             gchar const *format,
 152                                             va_list      args);
 153
 154 /* Check if a file name is an absolute path */
 155 gboolean              g_path_is_absolute   (const gchar *file_name);
 156
 157 /* In case of absolute paths, skip the root part */
 158 G_CONST_RETURN gchar* g_path_skip_root     (const gchar *file_name);
 159
 160 #ifndef G_DISABLE_DEPRECATED
 161
 162 /* These two functions are deprecated and will be removed in the next
 163  * major release of GLib. Use g_path_get_dirname/g_path_get_basename
 164  * instead. Whatch out! The string returned by g_path_get_basename
 165  * must be g_freed, while the string returned by g_basename must not.*/
 166 G_CONST_RETURN gchar* g_basename           (const gchar *file_name);
 167 #define g_dirname g_path_get_dirname
 168
 169 #endif /* G_DISABLE_DEPRECATED */
 170
 171 #ifdef G_OS_WIN32
 172 #define g_get_current_dir g_get_current_dir_utf8
 173 #endif
 174
 175 /* The returned strings are newly allocated with g_malloc() */
 176 gchar*                g_get_current_dir    (void);
 177 gchar*                g_path_get_basename  (const gchar *file_name) G_GNUC_MALLOC;
 178 gchar*                g_path_get_dirname   (const gchar *file_name) G_GNUC_MALLOC;
 179
 180 /* Set the pointer at the specified location to NULL */
 181 void                  g_nullify_pointer    (gpointer    *nullify_location);
 182
 183 /* return the environment string for the variable. The returned memory
 184  * must not be freed. */
 185 #ifdef G_OS_WIN32
 186 #define g_getenv g_getenv_utf8
 187 #define g_setenv g_setenv_utf8
 188 #define g_unsetenv g_unsetenv_utf8
 189 #define g_find_program_in_path g_find_program_in_path_utf8
 190 #endif
 191
 192 G_CONST_RETURN gchar* g_getenv             (const gchar *variable);
 193 gboolean              g_setenv             (const gchar *variable,
 194                                             const gchar *value,
 195                                             gboolean     overwrite);
 196 void                  g_unsetenv           (const gchar *variable);
 197 gchar**               g_listenv            (void);
 198
 199 /* we try to provide a usefull equivalent for ATEXIT if it is
 200  * not defined, but use is actually abandoned. people should
 201  * use g_atexit() instead.
 202  */
 203 typedef void            (*GVoidFunc)            (void);
 204 #ifndef ATEXIT
 205 # define ATEXIT(proc)   g_ATEXIT(proc)
 206 #else
 207 # define G_NATIVE_ATEXIT
 208 #endif /* ATEXIT */
 209 /* we use a GLib function as a replacement for ATEXIT, so
 210  * the programmer is not required to check the return value
 211  * (if there is any in the implementation) and doesn't encounter
 212  * missing include files.
 213  */
 214 void    g_atexit                (GVoidFunc    func);
 215
 216 /* Look for an executable in PATH, following execvp() rules */
 217 gchar*  g_find_program_in_path  (const gchar *program);
 218
 219 /* Bit tests
 220  */
 221 G_INLINE_FUNC gint      g_bit_nth_lsf (gulong  mask,
 222                                        gint    nth_bit);
 223 G_INLINE_FUNC gint      g_bit_nth_msf (gulong  mask,
 224                                        gint    nth_bit);
 225 G_INLINE_FUNC guint     g_bit_storage (gulong  number);
 226
 227 /* Trash Stacks
 228  * elements need to be >= sizeof (gpointer)
 229  */
 230 typedef struct _GTrashStack     GTrashStack;
 231 struct _GTrashStack
 232 {
 233   GTrashStack *next;
 234 };
 235
 236 G_INLINE_FUNC void      g_trash_stack_push      (GTrashStack **stack_p,
 237                                                  gpointer      data_p);
 238 G_INLINE_FUNC gpointer  g_trash_stack_pop       (GTrashStack **stack_p);
 239 G_INLINE_FUNC gpointer  g_trash_stack_peek      (GTrashStack **stack_p);
 240 G_INLINE_FUNC guint     g_trash_stack_height    (GTrashStack **stack_p);
 241
 242 /* inline function implementations
 243  */
 244 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 245 G_INLINE_FUNC gint
 246 g_bit_nth_lsf (gulong mask,
 247                gint   nth_bit)
 248 {
 249   do
 250     {
 251       nth_bit++;
 252       if (mask & (1UL << nth_bit))
 253         return nth_bit;
 254     }
 255   while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1));
 256   return -1;
 257 }
 258 G_INLINE_FUNC gint
 259 g_bit_nth_msf (gulong mask,
 260                gint   nth_bit)
 261 {
 262   if (nth_bit < 0)
 263     nth_bit = GLIB_SIZEOF_LONG * 8;
 264   do
 265     {
 266       nth_bit--;
 267       if (mask & (1UL << nth_bit))
 268         return nth_bit;
 269     }
 270   while (nth_bit > 0);
 271   return -1;
 272 }
 273 G_INLINE_FUNC guint
 274 g_bit_storage (gulong number)
 275 {
 276   register guint n_bits = 0;
 277
 278   do
 279     {
 280       n_bits++;
 281       number >>= 1;
 282     }
 283   while (number);
 284   return n_bits;
 285 }
 286 G_INLINE_FUNC void
 287 g_trash_stack_push (GTrashStack **stack_p,
 288                     gpointer      data_p)
 289 {
 290   GTrashStack *data = (GTrashStack *) data_p;
 291
 292   data->next = *stack_p;
 293   *stack_p = data;
 294 }
 295 G_INLINE_FUNC gpointer
 296 g_trash_stack_pop (GTrashStack **stack_p)
 297 {
 298   GTrashStack *data;
 299
 300   data = *stack_p;
 301   if (data)
 302     {
 303       *stack_p = data->next;
 304       /* NULLify private pointer here, most platforms store NULL as
 305        * subsequent 0 bytes
 306        */
 307       data->next = NULL;
 308     }
 309
 310   return data;
 311 }
 312 G_INLINE_FUNC gpointer
 313 g_trash_stack_peek (GTrashStack **stack_p)
 314 {
 315   GTrashStack *data;
 316
 317   data = *stack_p;
 318
 319   return data;
 320 }
 321 G_INLINE_FUNC guint
 322 g_trash_stack_height (GTrashStack **stack_p)
 323 {
 324   GTrashStack *data;
 325   guint i = 0;
 326
 327   for (data = *stack_p; data; data = data->next)
 328     i++;
 329
 330   return i;
 331 }
 332 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 333
 334 /* Glib version.
 335  * we prefix variable declarations so they can
 336  * properly get exported in windows dlls.
 337  */
 338 GLIB_VAR const guint glib_major_version;
 339 GLIB_VAR const guint glib_minor_version;
 340 GLIB_VAR const guint glib_micro_version;
 341 GLIB_VAR const guint glib_interface_age;
 342 GLIB_VAR const guint glib_binary_age;
 343
 344 const gchar * glib_check_version (guint required_major,
 345                                   guint required_minor,
 346                                   guint required_micro);
 347
 348 #define GLIB_CHECK_VERSION(major,minor,micro)    \
 349     (GLIB_MAJOR_VERSION > (major) || \
 350      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 351      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
 352       GLIB_MICRO_VERSION >= (micro)))
 353
 354 G_END_DECLS
 355
 356 /*
 357  * On Windows, this macro defines a DllMain function that stores the
 358  * actual DLL name that the code being compiled will be included in.
 359  * STATIC should be empty or 'static'. DLL_NAME is the name of the
 360  * (pointer to the) char array where the DLL name will be stored. If
 361  * this is used, you must also include <windows.h>. If you need a more complex
 362  * DLL entry point function, you cannot use this.
 363  *
 364  * On non-Windows platforms, expands to nothing.
 365  */
 366
 367 #ifndef G_PLATFORM_WIN32
 368 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
 369 #else
 370 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)                    \
 371 static char *dll_name;                                                     \
 372                                                                            \
 373 BOOL WINAPI                                                                \
 374 DllMain (HINSTANCE hinstDLL,                                               \
 375          DWORD     fdwReason,                                              \
 376          LPVOID    lpvReserved)                                            \
 377 {                                                                          \
 378   char bfr[1000];                                                          \
 379   switch (fdwReason)                                                       \
 380     {                                                                      \
 381     case DLL_PROCESS_ATTACH:                                               \
 382       GetModuleFileName ((HMODULE) hinstDLL, bfr, sizeof (bfr));           \
 383       dll_name = g_path_get_basename (bfr);                                \
 384       break;                                                               \
 385     }                                                                      \
 386                                                                            \
 387   return TRUE;                                                             \
 388 }
 389 #endif /* G_PLATFORM_WIN32 */
 390
 391 #endif /* __G_UTILS_H__ */