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 <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__) && (__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 gchar*  g_get_user_name         (void);
 117 gchar*  g_get_real_name         (void);
 118 gchar*  g_get_home_dir          (void);
 119 gchar*  g_get_tmp_dir           (void);
 120 gchar*  g_get_prgname           (void);
 121 void    g_set_prgname           (const gchar *prgname);
 122
 123
 124 typedef struct _GDebugKey       GDebugKey;
 125 struct _GDebugKey
 126 {
 127   gchar *key;
 128   guint  value;
 129 };
 130
 131 /* Miscellaneous utility functions
 132  */
 133 guint   g_parse_debug_string    (const gchar *string,
 134                                  GDebugKey   *keys,
 135                                  guint        nkeys);
 136 gint    g_snprintf              (gchar       *string,
 137                                  gulong       n,
 138                                  gchar const *format,
 139                                  ...) G_GNUC_PRINTF (3, 4);
 140 gint    g_vsnprintf             (gchar       *string,
 141                                  gulong       n,
 142                                  gchar const *format,
 143                                  va_list      args);
 144 /* Check if a file name is an absolute path */
 145 gboolean g_path_is_absolute     (const gchar *file_name);
 146 /* In case of absolute paths, skip the root part */
 147 gchar*  g_path_skip_root        (gchar       *file_name);
 148
 149 /* These two functions are deprecated and will be removed in the next
 150  * major release of GLib. Use g_path_get_dirname/g_path_get_basename
 151  * instead. Whatch out! The string returned by g_path_get_basename
 152  * must be g_freed, while the string returned by g_basename must not.*/
 153 gchar*  g_basename              (const gchar *file_name);
 154 gchar*  g_dirname               (const gchar *file_name);
 155
 156 /* The returned strings are newly allocated with g_malloc() */
 157 gchar*  g_get_current_dir       (void);
 158 gchar*  g_path_get_basename     (const gchar *file_name);
 159 gchar*  g_path_get_dirname      (const gchar *file_name);
 160
 161 /* Get the codeset for the current locale */
 162 /* gchar * g_get_codeset    (void); */
 163
 164 /* return the environment string for the variable. The returned memory
 165  * must not be freed. */
 166 gchar*  g_getenv                (const gchar *variable);
 167
 168
 169 /* we try to provide a usefull equivalent for ATEXIT if it is
 170  * not defined, but use is actually abandoned. people should
 171  * use g_atexit() instead.
 172  */
 173 typedef void            (*GVoidFunc)            (void);
 174 #ifndef ATEXIT
 175 # define ATEXIT(proc)   g_ATEXIT(proc)
 176 #else
 177 # define G_NATIVE_ATEXIT
 178 #endif /* ATEXIT */
 179 /* we use a GLib function as a replacement for ATEXIT, so
 180  * the programmer is not required to check the return value
 181  * (if there is any in the implementation) and doesn't encounter
 182  * missing include files.
 183  */
 184 void    g_atexit                (GVoidFunc    func);
 185
 186
 187 /* Bit tests
 188  */
 189 G_INLINE_FUNC gint      g_bit_nth_lsf (guint32 mask,
 190                                        gint    nth_bit);
 191 G_INLINE_FUNC gint      g_bit_nth_msf (guint32 mask,
 192                                        gint    nth_bit);
 193 G_INLINE_FUNC guint     g_bit_storage (guint number);
 194
 195 /* Trash Stacks
 196  * elements need to be >= sizeof (gpointer)
 197  */
 198 typedef struct _GTrashStack     GTrashStack;
 199 struct _GTrashStack
 200 {
 201   GTrashStack *next;
 202 };
 203
 204 G_INLINE_FUNC void      g_trash_stack_push      (GTrashStack **stack_p,
 205                                                  gpointer      data_p);
 206 G_INLINE_FUNC gpointer  g_trash_stack_pop       (GTrashStack **stack_p);
 207 G_INLINE_FUNC gpointer  g_trash_stack_peek      (GTrashStack **stack_p);
 208 G_INLINE_FUNC guint     g_trash_stack_height    (GTrashStack **stack_p);
 209
 210 /* inline function implementations
 211  */
 212 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 213 G_INLINE_FUNC gint
 214 g_bit_nth_lsf (guint32 mask,
 215                gint    nth_bit)
 216 {
 217   do
 218     {
 219       nth_bit++;
 220       if (mask & (1 << (guint) nth_bit))
 221         return nth_bit;
 222     }
 223   while (nth_bit < 32);
 224   return -1;
 225 }
 226 G_INLINE_FUNC gint
 227 g_bit_nth_msf (guint32 mask,
 228                gint    nth_bit)
 229 {
 230   if (nth_bit < 0)
 231     nth_bit = 32;
 232   do
 233     {
 234       nth_bit--;
 235       if (mask & (1 << (guint) nth_bit))
 236         return nth_bit;
 237     }
 238   while (nth_bit > 0);
 239   return -1;
 240 }
 241 G_INLINE_FUNC guint
 242 g_bit_storage (guint number)
 243 {
 244   register guint n_bits = 0;
 245
 246   do
 247     {
 248       n_bits++;
 249       number >>= 1;
 250     }
 251   while (number);
 252   return n_bits;
 253 }
 254 G_INLINE_FUNC void
 255 g_trash_stack_push (GTrashStack **stack_p,
 256                     gpointer      data_p)
 257 {
 258   GTrashStack *data = (GTrashStack *) data_p;
 259
 260   data->next = *stack_p;
 261   *stack_p = data;
 262 }
 263 G_INLINE_FUNC gpointer
 264 g_trash_stack_pop (GTrashStack **stack_p)
 265 {
 266   GTrashStack *data;
 267
 268   data = *stack_p;
 269   if (data)
 270     {
 271       *stack_p = data->next;
 272       /* NULLify private pointer here, most platforms store NULL as
 273        * subsequent 0 bytes
 274        */
 275       data->next = NULL;
 276     }
 277
 278   return data;
 279 }
 280 G_INLINE_FUNC gpointer
 281 g_trash_stack_peek (GTrashStack **stack_p)
 282 {
 283   GTrashStack *data;
 284
 285   data = *stack_p;
 286
 287   return data;
 288 }
 289 G_INLINE_FUNC guint
 290 g_trash_stack_height (GTrashStack **stack_p)
 291 {
 292   GTrashStack *data;
 293   guint i = 0;
 294
 295   for (data = *stack_p; data; data = data->next)
 296     i++;
 297
 298   return i;
 299 }
 300 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 301
 302 /* Glib version.
 303  * we prefix variable declarations so they can
 304  * properly get exported in windows dlls.
 305  */
 306 #ifdef G_OS_WIN32
 307 #  ifdef GLIB_COMPILATION
 308 #    define GLIB_VAR __declspec(dllexport)
 309 #  else /* !GLIB_COMPILATION */
 310 #    define GLIB_VAR extern __declspec(dllimport)
 311 #  endif /* !GLIB_COMPILATION */
 312 #else /* !G_OS_WIN32 */
 313 #  define GLIB_VAR extern
 314 #endif /* !G_OS_WIN32 */
 315
 316 GLIB_VAR const guint glib_major_version;
 317 GLIB_VAR const guint glib_minor_version;
 318 GLIB_VAR const guint glib_micro_version;
 319 GLIB_VAR const guint glib_interface_age;
 320 GLIB_VAR const guint glib_binary_age;
 321
 322 #define GLIB_CHECK_VERSION(major,minor,micro)    \
 323     (GLIB_MAJOR_VERSION > (major) || \
 324      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 325      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
 326       GLIB_MICRO_VERSION >= (micro)))
 327
 328 G_END_DECLS
 329
 330 #endif /* __G_UTILS_H__ */
 331
 332
 333