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