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