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