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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gtypes.h>
  35 #include <stdarg.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
  40  * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
  41  */
  42 #if !defined (G_VA_COPY)
  43 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
  44 #    define G_VA_COPY(ap1, ap2)   (*(ap1) = *(ap2))
  45 #  elif defined (G_VA_COPY_AS_ARRAY)
  46 #    define G_VA_COPY(ap1, ap2)   g_memmove ((ap1), (ap2), sizeof (va_list))
  47 #  else /* va_list is a pointer */
  48 #    define G_VA_COPY(ap1, ap2)   ((ap1) = (ap2))
  49 #  endif /* va_list is a pointer */
  50 #endif /* !G_VA_COPY */
  51
  52 /* inlining hassle. for compilers that don't allow the `inline' keyword,
  53  * mostly because of strict ANSI C compliance or dumbness, we try to fall
  54  * back to either `__inline__' or `__inline'.
  55  * G_CAN_INLINE is defined in glibconfig.h if the compiler seems to be
  56  * actually *capable* to do function inlining, in which case inline
  57  * function bodies do make sense. we also define G_INLINE_FUNC to properly
  58  * export the function prototypes if no inlining can be performed.
  59  * inline function bodies have to be special cased with G_CAN_INLINE and a
  60  * .c file specific macro to allow one compiled instance with extern linkage
  61  * of the functions by defining G_IMPLEMENT_INLINES and the .c file macro.
  62  */
  63 #if defined (G_HAVE_INLINE) && defined (__GNUC__) && defined (__STRICT_ANSI__)
  64 #  undef inline
  65 #  define inline __inline__
  66 #elif !defined (G_HAVE_INLINE)
  67 #  undef inline
  68 #  if defined (G_HAVE___INLINE__)
  69 #    define inline __inline__
  70 #  elif defined (G_HAVE___INLINE)
  71 #    define inline __inline
  72 #  else /* !inline && !__inline__ && !__inline */
  73 #    define inline  /* don't inline, then */
  74 #  endif
  75 #endif
  76 #ifdef G_IMPLEMENT_INLINES
  77 #  define G_INLINE_FUNC
  78 #  undef  G_CAN_INLINE
  79 #elif defined (__GNUC__)
  80 #  define G_INLINE_FUNC static __inline __attribute__ ((unused))
  81 #elif defined (G_CAN_INLINE)
  82 #  define G_INLINE_FUNC static inline
  83 #else /* can't inline */
  84 #  define G_INLINE_FUNC
  85 #endif /* !G_INLINE_FUNC */
  86
  87 const gchar *         g_get_user_name        (void);
  88 const gchar *         g_get_real_name        (void);
  89 const gchar *         g_get_home_dir         (void);
  90 const gchar *         g_get_tmp_dir          (void);
  91 const gchar *         g_get_host_name        (void);
  92 const gchar *         g_get_prgname          (void);
  93 void                  g_set_prgname          (const gchar *prgname);
  94 const gchar *         g_get_application_name (void);
  95 void                  g_set_application_name (const gchar *application_name);
  96
  97 void      g_reload_user_special_dirs_cache     (void);
  98 const gchar *         g_get_user_data_dir      (void);
  99 const gchar *         g_get_user_config_dir    (void);
 100 const gchar *         g_get_user_cache_dir     (void);
 101 const gchar * const * g_get_system_data_dirs   (void);
 102
 103 #ifdef G_OS_WIN32
 104 /* This functions is not part of the public GLib API */
 105 const gchar * const * g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void));
 106 #endif
 107
 108 #if defined (G_OS_WIN32) && defined (G_CAN_INLINE) && !defined (__cplusplus)
 109 /* This function is not part of the public GLib API either. Just call
 110  * g_get_system_data_dirs() in your code, never mind that that is
 111  * actually a macro and you will in fact call this inline function.
 112  */
 113 static inline const gchar * const *
 114 _g_win32_get_system_data_dirs (void)
 115 {
 116   return g_win32_get_system_data_dirs_for_module ((void (*)(void)) &_g_win32_get_system_data_dirs);
 117 }
 118 #define g_get_system_data_dirs _g_win32_get_system_data_dirs
 119 #endif
 120
 121 const gchar * const * g_get_system_config_dirs (void);
 122
 123 const gchar * g_get_user_runtime_dir (void);
 124
 125 /**
 126  * GUserDirectory:
 127  * @G_USER_DIRECTORY_DESKTOP: the user's Desktop directory
 128  * @G_USER_DIRECTORY_DOCUMENTS: the user's Documents directory
 129  * @G_USER_DIRECTORY_DOWNLOAD: the user's Downloads directory
 130  * @G_USER_DIRECTORY_MUSIC: the user's Music directory
 131  * @G_USER_DIRECTORY_PICTURES: the user's Pictures directory
 132  * @G_USER_DIRECTORY_PUBLIC_SHARE: the user's shared directory
 133  * @G_USER_DIRECTORY_TEMPLATES: the user's Templates directory
 134  * @G_USER_DIRECTORY_VIDEOS: the user's Movies directory
 135  * @G_USER_N_DIRECTORIES: the number of enum values
 136  *
 137  * These are logical ids for special directories which are defined
 138  * depending on the platform used. You should use g_get_user_special_dir()
 139  * to retrieve the full path associated to the logical id.
 140  *
 141  * The #GUserDirectory enumeration can be extended at later date. Not
 142  * every platform has a directory for every logical id in this
 143  * enumeration.
 144  *
 145  * Since: 2.14
 146  */
 147 typedef enum {
 148   G_USER_DIRECTORY_DESKTOP,
 149   G_USER_DIRECTORY_DOCUMENTS,
 150   G_USER_DIRECTORY_DOWNLOAD,
 151   G_USER_DIRECTORY_MUSIC,
 152   G_USER_DIRECTORY_PICTURES,
 153   G_USER_DIRECTORY_PUBLIC_SHARE,
 154   G_USER_DIRECTORY_TEMPLATES,
 155   G_USER_DIRECTORY_VIDEOS,
 156
 157   G_USER_N_DIRECTORIES
 158 } GUserDirectory;
 159
 160 const gchar * g_get_user_special_dir (GUserDirectory directory);
 161
 162 /**
 163  * GDebugKey:
 164  * @key: the string
 165  * @value: the flag
 166  *
 167  * Associates a string with a bit flag.
 168  * Used in g_parse_debug_string().
 169  */
 170 typedef struct _GDebugKey GDebugKey;
 171 struct _GDebugKey
 172 {
 173   const gchar *key;
 174   guint        value;
 175 };
 176
 177 /* Miscellaneous utility functions
 178  */
 179 guint                 g_parse_debug_string (const gchar     *string,
 180                                             const GDebugKey *keys,
 181                                             guint            nkeys);
 182
 183 gint                  g_snprintf           (gchar       *string,
 184                                             gulong       n,
 185                                             gchar const *format,
 186                                             ...) G_GNUC_PRINTF (3, 4);
 187 gint                  g_vsnprintf          (gchar       *string,
 188                                             gulong       n,
 189                                             gchar const *format,
 190                                             va_list      args)
 191                                             G_GNUC_PRINTF(3, 0);
 192
 193 void                  g_nullify_pointer    (gpointer    *nullify_location);
 194
 195 typedef enum
 196 {
 197   G_FORMAT_SIZE_DEFAULT     = 0,
 198   G_FORMAT_SIZE_LONG_FORMAT = 1 << 0,
 199   G_FORMAT_SIZE_IEC_UNITS   = 1 << 1
 200 } GFormatSizeFlags;
 201
 202 GLIB_AVAILABLE_IN_2_30
 203 gchar *g_format_size_full   (guint64          size,
 204                              GFormatSizeFlags flags);
 205 GLIB_AVAILABLE_IN_2_30
 206 gchar *g_format_size        (guint64          size);
 207
 208 GLIB_DEPRECATED_FOR(g_format_size)
 209 gchar *g_format_size_for_display (goffset size);
 210
 211 #ifndef G_DISABLE_DEPRECATED
 212 /**
 213  * GVoidFunc:
 214  *
 215  * Declares a type of function which takes no arguments
 216  * and has no return value. It is used to specify the type
 217  * function passed to g_atexit().
 218  */
 219 typedef void (*GVoidFunc) (void);
 220 #ifndef ATEXIT
 221 # define ATEXIT(proc) g_ATEXIT(proc)
 222 #else
 223 # define G_NATIVE_ATEXIT
 224 #endif /* ATEXIT */
 225 /* we use a GLib function as a replacement for ATEXIT, so
 226  * the programmer is not required to check the return value
 227  * (if there is any in the implementation) and doesn't encounter
 228  * missing include files.
 229  */
 230 GLIB_DEPRECATED
 231 void    g_atexit                (GVoidFunc    func);
 232
 233 #ifdef G_OS_WIN32
 234 /* It's a bad idea to wrap atexit() on Windows. If the GLib DLL calls
 235  * atexit(), the function will be called when the GLib DLL is detached
 236  * from the program, which is not what the caller wants. The caller
 237  * wants the function to be called when it *itself* exits (or is
 238  * detached, in case the caller, too, is a DLL).
 239  */
 240 #if (defined(__MINGW_H) && !defined(_STDLIB_H_)) || (defined(_MSC_VER) && !defined(_INC_STDLIB))
 241 int atexit (void (*)(void));
 242 #endif
 243 #define g_atexit(func) atexit(func)
 244 #endif
 245
 246 #endif  /* G_DISABLE_DEPRECATED */
 247
 248
 249 /* Look for an executable in PATH, following execvp() rules */
 250 gchar*  g_find_program_in_path  (const gchar *program);
 251
 252 /* Bit tests
 253  */
 254 G_INLINE_FUNC gint      g_bit_nth_lsf (gulong  mask,
 255                                        gint    nth_bit) G_GNUC_CONST;
 256 G_INLINE_FUNC gint      g_bit_nth_msf (gulong  mask,
 257                                        gint    nth_bit) G_GNUC_CONST;
 258 G_INLINE_FUNC guint     g_bit_storage (gulong  number) G_GNUC_CONST;
 259
 260 /* inline function implementations
 261  */
 262 #if defined (G_CAN_INLINE) || defined (__G_UTILS_C__)
 263 G_INLINE_FUNC gint
 264 g_bit_nth_lsf (gulong mask,
 265                gint   nth_bit)
 266 {
 267   if (G_UNLIKELY (nth_bit < -1))
 268     nth_bit = -1;
 269   while (nth_bit < ((GLIB_SIZEOF_LONG * 8) - 1))
 270     {
 271       nth_bit++;
 272       if (mask & (1UL << nth_bit))
 273         return nth_bit;
 274     }
 275   return -1;
 276 }
 277 G_INLINE_FUNC gint
 278 g_bit_nth_msf (gulong mask,
 279                gint   nth_bit)
 280 {
 281   if (nth_bit < 0 || G_UNLIKELY (nth_bit > GLIB_SIZEOF_LONG * 8))
 282     nth_bit = GLIB_SIZEOF_LONG * 8;
 283   while (nth_bit > 0)
 284     {
 285       nth_bit--;
 286       if (mask & (1UL << nth_bit))
 287         return nth_bit;
 288     }
 289   return -1;
 290 }
 291 G_INLINE_FUNC guint
 292 g_bit_storage (gulong number)
 293 {
 294 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__OPTIMIZE__)
 295   return G_LIKELY (number) ?
 296            ((GLIB_SIZEOF_LONG * 8U - 1) ^ (guint) __builtin_clzl(number)) + 1 : 1;
 297 #else
 298   register guint n_bits = 0;
 299
 300   do
 301     {
 302       n_bits++;
 303       number >>= 1;
 304     }
 305   while (number);
 306   return n_bits;
 307 #endif
 308 }
 309 #endif  /* G_CAN_INLINE || __G_UTILS_C__ */
 310
 311 #ifndef G_DISABLE_DEPRECATED
 312
 313 /*
 314  * This macro is deprecated. This DllMain() is too complex. It is
 315  * recommended to write an explicit minimal DLlMain() that just saves
 316  * the handle to the DLL and then use that handle instead, for
 317  * instance passing it to
 318  * g_win32_get_package_installation_directory_of_module().
 319  *
 320  * On Windows, this macro defines a DllMain function that stores the
 321  * actual DLL name that the code being compiled will be included in.
 322  * STATIC should be empty or 'static'. DLL_NAME is the name of the
 323  * (pointer to the) char array where the DLL name will be stored. If
 324  * this is used, you must also include <windows.h>. If you need a more complex
 325  * DLL entry point function, you cannot use this.
 326  *
 327  * On non-Windows platforms, expands to nothing.
 328  */
 329
 330 #ifndef G_PLATFORM_WIN32
 331 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
 332 #else
 333 # define G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)                 \
 334 static char *dll_name;                                                  \
 335                                                                         \
 336 BOOL WINAPI                                                             \
 337 DllMain (HINSTANCE hinstDLL,                                            \
 338          DWORD     fdwReason,                                           \
 339          LPVOID    lpvReserved)                                         \
 340 {                                                                       \
 341   wchar_t wcbfr[1000];                                                  \
 342   char *tem;                                                            \
 343   switch (fdwReason)                                                    \
 344     {                                                                   \
 345     case DLL_PROCESS_ATTACH:                                            \
 346       GetModuleFileNameW ((HMODULE) hinstDLL, wcbfr, G_N_ELEMENTS (wcbfr)); \
 347       tem = g_utf16_to_utf8 (wcbfr, -1, NULL, NULL, NULL);              \
 348       dll_name = g_path_get_basename (tem);                             \
 349       g_free (tem);                                                     \
 350       break;                                                            \
 351     }                                                                   \
 352                                                                         \
 353   return TRUE;                                                          \
 354 }
 355
 356 #endif  /* !G_DISABLE_DEPRECATED */
 357
 358 #endif /* G_PLATFORM_WIN32 */
 359
 360 #ifdef G_OS_WIN32
 361 #define g_get_user_name        g_get_user_name_utf8
 362 #define g_get_real_name        g_get_real_name_utf8
 363 #define g_get_home_dir         g_get_home_dir_utf8
 364 #define g_get_tmp_dir          g_get_tmp_dir_utf8
 365 #define g_find_program_in_path g_find_program_in_path_utf8
 366
 367 const gchar *g_get_user_name_utf8        (void);
 368 const gchar *g_get_real_name_utf8        (void);
 369 const gchar *g_get_home_dir_utf8         (void);
 370 const gchar *g_get_tmp_dir_utf8          (void);
 371 gchar       *g_find_program_in_path_utf8 (const gchar *program);
 372 #endif
 373
 374 G_END_DECLS
 375
 376 #endif /* __G_UTILS_H__ */