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