glib/gutils.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1998  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 /*
  28  * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
  29  */
  30
  31 #include "config.h"
  32
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36 #include <stdarg.h>
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <locale.h>
  40 #include <string.h>
  41 #include <ctype.h>              /* For tolower() */
  42 #include <errno.h>
  43 #include <sys/types.h>
  44 #include <sys/stat.h>
  45 #ifdef HAVE_PWD_H
  46 #include <pwd.h>
  47 #endif
  48 #include <sys/types.h>
  49 #ifdef HAVE_SYS_PARAM_H
  50 #include <sys/param.h>
  51 #endif
  52 #ifdef HAVE_CRT_EXTERNS_H
  53 #include <crt_externs.h> /* for _NSGetEnviron */
  54 #endif
  55
  56 /* implement gutils's inline functions
  57  */
  58 #define G_IMPLEMENT_INLINES 1
  59 #define __G_UTILS_C__
  60 #include "gutils.h"
  61
  62 #include "glib-init.h"
  63 #include "glib-private.h"
  64 #include "genviron.h"
  65 #include "gfileutils.h"
  66 #include "ggettext.h"
  67 #include "ghash.h"
  68 #include "gthread.h"
  69 #include "gtestutils.h"
  70 #include "gunicode.h"
  71 #include "gstrfuncs.h"
  72 #include "garray.h"
  73 #include "glibintl.h"
  74
  75 #ifdef G_PLATFORM_WIN32
  76 #include "gconvert.h"
  77 #include "gwin32.h"
  78 #endif
  79
  80
  81 /**
  82  * SECTION:misc_utils
  83  * @title: Miscellaneous Utility Functions
  84  * @short_description: a selection of portable utility functions
  85  *
  86  * These are portable utility functions.
  87  */
  88
  89 #ifdef G_PLATFORM_WIN32
  90 #  include <windows.h>
  91 #  ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
  92 #    define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
  93 #    define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
  94 #  endif
  95 #  include <lmcons.h>           /* For UNLEN */
  96 #endif /* G_PLATFORM_WIN32 */
  97
  98 #ifdef G_OS_WIN32
  99 #  include <direct.h>
 100 #  include <shlobj.h>
 101    /* older SDK (e.g. msvc 5.0) does not have these*/
 102 #  ifndef CSIDL_MYMUSIC
 103 #    define CSIDL_MYMUSIC 13
 104 #  endif
 105 #  ifndef CSIDL_MYVIDEO
 106 #    define CSIDL_MYVIDEO 14
 107 #  endif
 108 #  ifndef CSIDL_INTERNET_CACHE
 109 #    define CSIDL_INTERNET_CACHE 32
 110 #  endif
 111 #  ifndef CSIDL_COMMON_APPDATA
 112 #    define CSIDL_COMMON_APPDATA 35
 113 #  endif
 114 #  ifndef CSIDL_MYPICTURES
 115 #    define CSIDL_MYPICTURES 0x27
 116 #  endif
 117 #  ifndef CSIDL_COMMON_DOCUMENTS
 118 #    define CSIDL_COMMON_DOCUMENTS 46
 119 #  endif
 120 #  ifndef CSIDL_PROFILE
 121 #    define CSIDL_PROFILE 40
 122 #  endif
 123 #  include <process.h>
 124 #endif
 125
 126 #ifdef HAVE_CARBON
 127 #include <CoreServices/CoreServices.h>
 128 #endif
 129
 130 #ifdef HAVE_CODESET
 131 #include <langinfo.h>
 132 #endif
 133
 134 #ifdef G_PLATFORM_WIN32
 135
 136 gchar *
 137 _glib_get_dll_directory (void)
 138 {
 139   gchar *retval;
 140   gchar *p;
 141   wchar_t wc_fn[MAX_PATH];
 142
 143 #ifdef DLL_EXPORT
 144   if (glib_dll == NULL)
 145     return NULL;
 146 #endif
 147
 148   /* This code is different from that in
 149    * g_win32_get_package_installation_directory_of_module() in that
 150    * here we return the actual folder where the GLib DLL is. We don't
 151    * do the check for it being in a "bin" or "lib" subfolder and then
 152    * returning the parent of that.
 153    *
 154    * In a statically built GLib, glib_dll will be NULL and we will
 155    * thus look up the application's .exe file's location.
 156    */
 157   if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
 158     return NULL;
 159
 160   retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
 161
 162   p = strrchr (retval, G_DIR_SEPARATOR);
 163   if (p == NULL)
 164     {
 165       /* Wtf? */
 166       return NULL;
 167     }
 168   *p = '\0';
 169
 170   return retval;
 171 }
 172
 173 #endif
 174
 175 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
 176 /**
 177  * g_memmove:
 178  * @dest: the destination address to copy the bytes to.
 179  * @src: the source address to copy the bytes from.
 180  * @len: the number of bytes to copy.
 181  *
 182  * Copies a block of memory @len bytes long, from @src to @dest.
 183  * The source and destination areas may overlap.
 184  *
 185  * In order to use this function, you must include
 186  * <filename>string.h</filename> yourself, because this macro will
 187  * typically simply resolve to memmove() and GLib does not include
 188  * <filename>string.h</filename> for you.
 189  */
 190 void
 191 g_memmove (gpointer      dest,
 192            gconstpointer src,
 193            gulong        len)
 194 {
 195   gchar* destptr = dest;
 196   const gchar* srcptr = src;
 197   if (src + len < dest || dest + len < src)
 198     {
 199       bcopy (src, dest, len);
 200       return;
 201     }
 202   else if (dest <= src)
 203     {
 204       while (len--)
 205         *(destptr++) = *(srcptr++);
 206     }
 207   else
 208     {
 209       destptr += len;
 210       srcptr += len;
 211       while (len--)
 212         *(--destptr) = *(--srcptr);
 213     }
 214 }
 215 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
 216
 217 #ifdef G_OS_WIN32
 218 #undef g_atexit
 219 #endif
 220
 221 /**
 222  * g_atexit:
 223  * @func: (scope async): the function to call on normal program termination.
 224  *
 225  * Specifies a function to be called at normal program termination.
 226  *
 227  * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
 228  * macro that maps to a call to the atexit() function in the C
 229  * library. This means that in case the code that calls g_atexit(),
 230  * i.e. atexit(), is in a DLL, the function will be called when the
 231  * DLL is detached from the program. This typically makes more sense
 232  * than that the function is called when the GLib DLL is detached,
 233  * which happened earlier when g_atexit() was a function in the GLib
 234  * DLL.
 235  *
 236  * The behaviour of atexit() in the context of dynamically loaded
 237  * modules is not formally specified and varies wildly.
 238  *
 239  * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
 240  * loaded module which is unloaded before the program terminates might
 241  * well cause a crash at program exit.
 242  *
 243  * Some POSIX systems implement atexit() like Windows, and have each
 244  * dynamically loaded module maintain an own atexit chain that is
 245  * called when the module is unloaded.
 246  *
 247  * On other POSIX systems, before a dynamically loaded module is
 248  * unloaded, the registered atexit functions (if any) residing in that
 249  * module are called, regardless where the code that registered them
 250  * resided. This is presumably the most robust approach.
 251  *
 252  * As can be seen from the above, for portability it's best to avoid
 253  * calling g_atexit() (or atexit()) except in the main executable of a
 254  * program.
 255  *
 256  * Deprecated:2.32: It is best to avoid g_atexit().
 257  */
 258 void
 259 g_atexit (GVoidFunc func)
 260 {
 261   gint result;
 262   const gchar *error = NULL;
 263
 264   /* keep this in sync with glib.h */
 265
 266 #ifdef  G_NATIVE_ATEXIT
 267   result = ATEXIT (func);
 268   if (result)
 269     error = g_strerror (errno);
 270 #elif defined (HAVE_ATEXIT)
 271 #  ifdef NeXT /* @#%@! NeXTStep */
 272   result = !atexit ((void (*)(void)) func);
 273   if (result)
 274     error = g_strerror (errno);
 275 #  else
 276   result = atexit ((void (*)(void)) func);
 277   if (result)
 278     error = g_strerror (errno);
 279 #  endif /* NeXT */
 280 #elif defined (HAVE_ON_EXIT)
 281   result = on_exit ((void (*)(int, void *)) func, NULL);
 282   if (result)
 283     error = g_strerror (errno);
 284 #else
 285   result = 0;
 286   error = "no implementation";
 287 #endif /* G_NATIVE_ATEXIT */
 288
 289   if (error)
 290     g_error ("Could not register atexit() function: %s", error);
 291 }
 292
 293 /* Based on execvp() from GNU Libc.
 294  * Some of this code is cut-and-pasted into gspawn.c
 295  */
 296
 297 static gchar*
 298 my_strchrnul (const gchar *str,
 299               gchar        c)
 300 {
 301   gchar *p = (gchar*)str;
 302   while (*p && (*p != c))
 303     ++p;
 304
 305   return p;
 306 }
 307
 308 #ifdef G_OS_WIN32
 309
 310 static gchar *inner_find_program_in_path (const gchar *program);
 311
 312 gchar*
 313 g_find_program_in_path (const gchar *program)
 314 {
 315   const gchar *last_dot = strrchr (program, '.');
 316
 317   if (last_dot == NULL ||
 318       strchr (last_dot, '\\') != NULL ||
 319       strchr (last_dot, '/') != NULL)
 320     {
 321       const gint program_length = strlen (program);
 322       gchar *pathext = g_build_path (";",
 323                                      ".exe;.cmd;.bat;.com",
 324                                      g_getenv ("PATHEXT"),
 325                                      NULL);
 326       gchar *p;
 327       gchar *decorated_program;
 328       gchar *retval;
 329
 330       p = pathext;
 331       do
 332         {
 333           gchar *q = my_strchrnul (p, ';');
 334
 335           decorated_program = g_malloc (program_length + (q-p) + 1);
 336           memcpy (decorated_program, program, program_length);
 337           memcpy (decorated_program+program_length, p, q-p);
 338           decorated_program [program_length + (q-p)] = '\0';
 339
 340           retval = inner_find_program_in_path (decorated_program);
 341           g_free (decorated_program);
 342
 343           if (retval != NULL)
 344             {
 345               g_free (pathext);
 346               return retval;
 347             }
 348           p = q;
 349         } while (*p++ != '\0');
 350       g_free (pathext);
 351       return NULL;
 352     }
 353   else
 354     return inner_find_program_in_path (program);
 355 }
 356
 357 #endif
 358
 359 /**
 360  * g_find_program_in_path:
 361  * @program: a program name in the GLib file name encoding
 362  *
 363  * Locates the first executable named @program in the user's path, in the
 364  * same way that execvp() would locate it. Returns an allocated string
 365  * with the absolute path name, or %NULL if the program is not found in
 366  * the path. If @program is already an absolute path, returns a copy of
 367  * @program if @program exists and is executable, and %NULL otherwise.
 368  *
 369  * On Windows, if @program does not have a file type suffix, tries
 370  * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
 371  * the <envar>PATHEXT</envar> environment variable.
 372  *
 373  * On Windows, it looks for the file in the same way as CreateProcess()
 374  * would. This means first in the directory where the executing
 375  * program was loaded from, then in the current directory, then in the
 376  * Windows 32-bit system directory, then in the Windows directory, and
 377  * finally in the directories in the <envar>PATH</envar> environment
 378  * variable. If the program is found, the return value contains the
 379  * full name including the type suffix.
 380  *
 381  * Return value: a newly-allocated string with the absolute path, or %NULL
 382  **/
 383 #ifdef G_OS_WIN32
 384 static gchar *
 385 inner_find_program_in_path (const gchar *program)
 386 #else
 387 gchar*
 388 g_find_program_in_path (const gchar *program)
 389 #endif
 390 {
 391   const gchar *path, *p;
 392   gchar *name, *freeme;
 393 #ifdef G_OS_WIN32
 394   const gchar *path_copy;
 395   gchar *filename = NULL, *appdir = NULL;
 396   gchar *sysdir = NULL, *windir = NULL;
 397   int n;
 398   wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
 399     wwindir[MAXPATHLEN];
 400 #endif
 401   gsize len;
 402   gsize pathlen;
 403
 404   g_return_val_if_fail (program != NULL, NULL);
 405
 406   /* If it is an absolute path, or a relative path including subdirectories,
 407    * don't look in PATH.
 408    */
 409   if (g_path_is_absolute (program)
 410       || strchr (program, G_DIR_SEPARATOR) != NULL
 411 #ifdef G_OS_WIN32
 412       || strchr (program, '/') != NULL
 413 #endif
 414       )
 415     {
 416       if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
 417           !g_file_test (program, G_FILE_TEST_IS_DIR))
 418         return g_strdup (program);
 419       else
 420         return NULL;
 421     }
 422
 423   path = g_getenv ("PATH");
 424 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
 425   if (path == NULL)
 426     {
 427       /* There is no `PATH' in the environment.  The default
 428        * search path in GNU libc is the current directory followed by
 429        * the path `confstr' returns for `_CS_PATH'.
 430        */
 431
 432       /* In GLib we put . last, for security, and don't use the
 433        * unportable confstr(); UNIX98 does not actually specify
 434        * what to search if PATH is unset. POSIX may, dunno.
 435        */
 436
 437       path = "/bin:/usr/bin:.";
 438     }
 439 #else
 440   n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
 441   if (n > 0 && n < MAXPATHLEN)
 442     filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
 443
 444   n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
 445   if (n > 0 && n < MAXPATHLEN)
 446     sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
 447
 448   n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
 449   if (n > 0 && n < MAXPATHLEN)
 450     windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
 451
 452   if (filename)
 453     {
 454       appdir = g_path_get_dirname (filename);
 455       g_free (filename);
 456     }
 457
 458   path = g_strdup (path);
 459
 460   if (windir)
 461     {
 462       const gchar *tem = path;
 463       path = g_strconcat (windir, ";", path, NULL);
 464       g_free ((gchar *) tem);
 465       g_free (windir);
 466     }
 467
 468   if (sysdir)
 469     {
 470       const gchar *tem = path;
 471       path = g_strconcat (sysdir, ";", path, NULL);
 472       g_free ((gchar *) tem);
 473       g_free (sysdir);
 474     }
 475
 476   {
 477     const gchar *tem = path;
 478     path = g_strconcat (".;", path, NULL);
 479     g_free ((gchar *) tem);
 480   }
 481
 482   if (appdir)
 483     {
 484       const gchar *tem = path;
 485       path = g_strconcat (appdir, ";", path, NULL);
 486       g_free ((gchar *) tem);
 487       g_free (appdir);
 488     }
 489
 490   path_copy = path;
 491 #endif
 492
 493   len = strlen (program) + 1;
 494   pathlen = strlen (path);
 495   freeme = name = g_malloc (pathlen + len + 1);
 496
 497   /* Copy the file name at the top, including '\0'  */
 498   memcpy (name + pathlen + 1, program, len);
 499   name = name + pathlen;
 500   /* And add the slash before the filename  */
 501   *name = G_DIR_SEPARATOR;
 502
 503   p = path;
 504   do
 505     {
 506       char *startp;
 507
 508       path = p;
 509       p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
 510
 511       if (p == path)
 512         /* Two adjacent colons, or a colon at the beginning or the end
 513          * of `PATH' means to search the current directory.
 514          */
 515         startp = name + 1;
 516       else
 517         startp = memcpy (name - (p - path), path, p - path);
 518
 519       if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
 520           !g_file_test (startp, G_FILE_TEST_IS_DIR))
 521         {
 522           gchar *ret;
 523           ret = g_strdup (startp);
 524           g_free (freeme);
 525 #ifdef G_OS_WIN32
 526           g_free ((gchar *) path_copy);
 527 #endif
 528           return ret;
 529         }
 530     }
 531   while (*p++ != '\0');
 532
 533   g_free (freeme);
 534 #ifdef G_OS_WIN32
 535   g_free ((gchar *) path_copy);
 536 #endif
 537
 538   return NULL;
 539 }
 540
 541 /**
 542  * g_bit_nth_lsf:
 543  * @mask: a #gulong containing flags
 544  * @nth_bit: the index of the bit to start the search from
 545  *
 546  * Find the position of the first bit set in @mask, searching
 547  * from (but not including) @nth_bit upwards. Bits are numbered
 548  * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
 549  * usually). To start searching from the 0th bit, set @nth_bit to -1.
 550  *
 551  * Returns: the index of the first bit set which is higher than @nth_bit
 552  */
 553
 554 /**
 555  * g_bit_nth_msf:
 556  * @mask: a #gulong containing flags
 557  * @nth_bit: the index of the bit to start the search from
 558  *
 559  * Find the position of the first bit set in @mask, searching
 560  * from (but not including) @nth_bit downwards. Bits are numbered
 561  * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
 562  * usually). To start searching from the last bit, set @nth_bit to
 563  * -1 or GLIB_SIZEOF_LONG * 8.
 564  *
 565  * Returns: the index of the first bit set which is lower than @nth_bit
 566  */
 567
 568 /**
 569  * g_bit_storage:
 570  * @number: a #guint
 571  *
 572  * Gets the number of bits used to hold @number,
 573  * e.g. if @number is 4, 3 bits are needed.
 574  *
 575  * Returns: the number of bits used to hold @number
 576  */
 577
 578 G_LOCK_DEFINE_STATIC (g_utils_global);
 579
 580 typedef struct
 581 {
 582   gchar *user_name;
 583   gchar *real_name;
 584   gchar *home_dir;
 585 } UserDatabaseEntry;
 586
 587 static  gchar   *g_user_data_dir = NULL;
 588 static  gchar  **g_system_data_dirs = NULL;
 589 static  gchar   *g_user_cache_dir = NULL;
 590 static  gchar   *g_user_config_dir = NULL;
 591 static  gchar  **g_system_config_dirs = NULL;
 592
 593 static  gchar  **g_user_special_dirs = NULL;
 594
 595 /* fifteen minutes of fame for everybody */
 596 #define G_USER_DIRS_EXPIRE      15 * 60
 597
 598 #ifdef G_OS_WIN32
 599
 600 static gchar *
 601 get_special_folder (int csidl)
 602 {
 603   wchar_t path[MAX_PATH+1];
 604   HRESULT hr;
 605   LPITEMIDLIST pidl = NULL;
 606   BOOL b;
 607   gchar *retval = NULL;
 608
 609   hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
 610   if (hr == S_OK)
 611     {
 612       b = SHGetPathFromIDListW (pidl, path);
 613       if (b)
 614         retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
 615       CoTaskMemFree (pidl);
 616     }
 617   return retval;
 618 }
 619
 620 static char *
 621 get_windows_directory_root (void)
 622 {
 623   wchar_t wwindowsdir[MAX_PATH];
 624
 625   if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
 626     {
 627       /* Usually X:\Windows, but in terminal server environments
 628        * might be an UNC path, AFAIK.
 629        */
 630       char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
 631       char *p;
 632
 633       if (windowsdir == NULL)
 634         return g_strdup ("C:\\");
 635
 636       p = (char *) g_path_skip_root (windowsdir);
 637       if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
 638         p--;
 639       *p = '\0';
 640       return windowsdir;
 641     }
 642   else
 643     return g_strdup ("C:\\");
 644 }
 645
 646 #endif
 647
 648 /* HOLDS: g_utils_global_lock */
 649 static UserDatabaseEntry *
 650 g_get_user_database_entry (void)
 651 {
 652   static UserDatabaseEntry *entry;
 653
 654   if (g_once_init_enter (&entry))
 655     {
 656       static UserDatabaseEntry e;
 657
 658 #ifdef HAVE_PWD_H
 659       {
 660         struct passwd *pw = NULL;
 661         gpointer buffer = NULL;
 662         gint error;
 663         gchar *logname;
 664
 665 #  if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
 666         struct passwd pwd;
 667 #    ifdef _SC_GETPW_R_SIZE_MAX
 668         /* This reurns the maximum length */
 669         glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
 670
 671         if (bufsize < 0)
 672           bufsize = 64;
 673 #    else /* _SC_GETPW_R_SIZE_MAX */
 674         glong bufsize = 64;
 675 #    endif /* _SC_GETPW_R_SIZE_MAX */
 676
 677         logname = (gchar *) g_getenv ("LOGNAME");
 678
 679         do
 680           {
 681             g_free (buffer);
 682             /* we allocate 6 extra bytes to work around a bug in
 683              * Mac OS < 10.3. See #156446
 684              */
 685             buffer = g_malloc (bufsize + 6);
 686             errno = 0;
 687
 688 #    ifdef HAVE_POSIX_GETPWUID_R
 689             if (logname) {
 690               error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
 691               if (!pw || (pw->pw_uid != getuid ())) {
 692                 /* LOGNAME is lying, fall back to looking up the uid */
 693                 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
 694               }
 695             } else {
 696               error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
 697             }
 698             error = error < 0 ? errno : error;
 699 #    else /* HAVE_NONPOSIX_GETPWUID_R */
 700        /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
 701 #      if defined(_AIX) || defined(__hpux)
 702             error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 703             pw = error == 0 ? &pwd : NULL;
 704 #      else /* !_AIX */
 705             if (logname) {
 706               pw = getpwnam_r (logname, &pwd, buffer, bufsize);
 707               if (!pw || (pw->pw_uid != getuid ())) {
 708                 /* LOGNAME is lying, fall back to looking up the uid */
 709                 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 710               }
 711             } else {
 712               pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
 713             }
 714             error = pw ? 0 : errno;
 715 #      endif /* !_AIX */
 716 #    endif /* HAVE_NONPOSIX_GETPWUID_R */
 717
 718             if (!pw)
 719               {
 720                 /* we bail out prematurely if the user id can't be found
 721                  * (should be pretty rare case actually), or if the buffer
 722                  * should be sufficiently big and lookups are still not
 723                  * successful.
 724                  */
 725                 if (error == 0 || error == ENOENT)
 726                   {
 727                     g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
 728                                (gulong) getuid ());
 729                     break;
 730                   }
 731                 if (bufsize > 32 * 1024)
 732                   {
 733                     g_warning ("getpwuid_r(): failed due to: %s.",
 734                                g_strerror (error));
 735                     break;
 736                   }
 737
 738                 bufsize *= 2;
 739               }
 740           }
 741         while (!pw);
 742 #  endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
 743
 744         if (!pw)
 745           {
 746 #ifndef __BIONIC__
 747             setpwent ();
 748 #endif
 749             pw = getpwuid (getuid ());
 750 #ifndef __BIONIC__
 751             endpwent ();
 752 #endif
 753           }
 754         if (pw)
 755           {
 756             e.user_name = g_strdup (pw->pw_name);
 757
 758 #ifndef __BIONIC__
 759             if (pw->pw_gecos && *pw->pw_gecos != '\0')
 760               {
 761                 gchar **gecos_fields;
 762                 gchar **name_parts;
 763
 764                 /* split the gecos field and substitute '&' */
 765                 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
 766                 name_parts = g_strsplit (gecos_fields[0], "&", 0);
 767                 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
 768                 e.real_name = g_strjoinv (pw->pw_name, name_parts);
 769                 g_strfreev (gecos_fields);
 770                 g_strfreev (name_parts);
 771               }
 772 #endif
 773
 774             if (!e.home_dir)
 775               e.home_dir = g_strdup (pw->pw_dir);
 776           }
 777         g_free (buffer);
 778       }
 779
 780 #else /* !HAVE_PWD_H */
 781
 782 #ifdef G_OS_WIN32
 783       {
 784         guint len = UNLEN+1;
 785         wchar_t buffer[UNLEN+1];
 786
 787         if (GetUserNameW (buffer, (LPDWORD) &len))
 788           {
 789             e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
 790             e.real_name = g_strdup (e.user_name);
 791           }
 792       }
 793 #endif /* G_OS_WIN32 */
 794
 795 #endif /* !HAVE_PWD_H */
 796
 797 #ifdef __EMX__
 798       /* change '\\' in %HOME% to '/' */
 799       g_strdelimit (e.home_dir, "\\",'/');
 800 #endif
 801       if (!e.user_name)
 802         e.user_name = g_strdup ("somebody");
 803       if (!e.real_name)
 804         e.real_name = g_strdup ("Unknown");
 805
 806       g_once_init_leave (&entry, &e);
 807     }
 808
 809   return entry;
 810 }
 811
 812 /**
 813  * g_get_user_name:
 814  *
 815  * Gets the user name of the current user. The encoding of the returned
 816  * string is system-defined. On UNIX, it might be the preferred file name
 817  * encoding, or something else, and there is no guarantee that it is even
 818  * consistent on a machine. On Windows, it is always UTF-8.
 819  *
 820  * Returns: the user name of the current user.
 821  */
 822 const gchar *
 823 g_get_user_name (void)
 824 {
 825   UserDatabaseEntry *entry;
 826
 827   entry = g_get_user_database_entry ();
 828
 829   return entry->user_name;
 830 }
 831
 832 /**
 833  * g_get_real_name:
 834  *
 835  * Gets the real name of the user. This usually comes from the user's entry
 836  * in the <filename>passwd</filename> file. The encoding of the returned
 837  * string is system-defined. (On Windows, it is, however, always UTF-8.)
 838  * If the real user name cannot be determined, the string "Unknown" is
 839  * returned.
 840  *
 841  * Returns: the user's real name.
 842  */
 843 const gchar *
 844 g_get_real_name (void)
 845 {
 846   UserDatabaseEntry *entry;
 847
 848   entry = g_get_user_database_entry ();
 849
 850   return entry->real_name;
 851 }
 852
 853 /**
 854  * g_get_home_dir:
 855  *
 856  * Gets the current user's home directory.
 857  *
 858  * As with most UNIX tools, this function will return the value of the
 859  * <envar>HOME</envar> environment variable if it is set to an existing
 860  * absolute path name, falling back to the <filename>passwd</filename>
 861  * file in the case that it is unset.
 862  *
 863  * If the path given in <envar>HOME</envar> is non-absolute, does not
 864  * exist, or is not a directory, the result is undefined.
 865  *
 866  * <note><para>
 867  *   Before version 2.36 this function would ignore the
 868  *   <envar>HOME</envar> environment variable, taking the value from the
 869  *   <filename>passwd</filename> database instead.  This was changed to
 870  *   increase the compatibility of GLib with other programs (and the XDG
 871  *   basedir specification) and to increase testability of programs
 872  *   based on GLib (by making it easier to run them from test
 873  *   frameworks).
 874  * </para><para>
 875  *   If your program has a strong requirement for either the new or the
 876  *   old behaviour (and if you don't wish to increase your GLib
 877  *   dependency to ensure that the new behaviour is in effect) then you
 878  *   should either directly check the <envar>HOME</envar> environment
 879  *   variable yourself or unset it before calling any functions in GLib.
 880  * </para></note>
 881  *
 882  * Returns: the current user's home directory
 883  */
 884 const gchar *
 885 g_get_home_dir (void)
 886 {
 887   static gchar *home_dir;
 888
 889   if (g_once_init_enter (&home_dir))
 890     {
 891       gchar *tmp;
 892
 893       /* We first check HOME and use it if it is set */
 894       tmp = g_strdup (g_getenv ("HOME"));
 895
 896 #ifdef G_OS_WIN32
 897       /* Only believe HOME if it is an absolute path and exists.
 898        *
 899        * We only do this check on Windows for a couple of reasons.
 900        * Historically, we only did it there because we used to ignore $HOME
 901        * on UNIX.  There are concerns about enabling it now on UNIX because
 902        * of things like autofs.  In short, if the user has a bogus value in
 903        * $HOME then they get what they pay for...
 904        */
 905       if (tmp)
 906         {
 907           if (!(g_path_is_absolute (tmp) &&
 908                 g_file_test (tmp, G_FILE_TEST_IS_DIR)))
 909             {
 910               g_free (tmp);
 911               tmp = NULL;
 912             }
 913         }
 914
 915       /* In case HOME is Unix-style (it happens), convert it to
 916        * Windows style.
 917        */
 918       if (tmp)
 919         {
 920           gchar *p;
 921           while ((p = strchr (tmp, '/')) != NULL)
 922             *p = '\\';
 923         }
 924
 925       if (!tmp)
 926         {
 927           /* USERPROFILE is probably the closest equivalent to $HOME? */
 928           if (g_getenv ("USERPROFILE") != NULL)
 929             tmp = g_strdup (g_getenv ("USERPROFILE"));
 930         }
 931
 932       if (!tmp)
 933         tmp = get_special_folder (CSIDL_PROFILE);
 934
 935       if (!tmp)
 936         tmp = get_windows_directory_root ();
 937 #endif /* G_OS_WIN32 */
 938
 939       if (!tmp)
 940         {
 941           /* If we didn't get it from any of those methods, we will have
 942            * to read the user database entry.
 943            */
 944           UserDatabaseEntry *entry;
 945
 946           entry = g_get_user_database_entry ();
 947
 948           /* Strictly speaking, we should copy this, but we know that
 949            * neither will ever be freed, so don't bother...
 950            */
 951           tmp = entry->home_dir;
 952         }
 953
 954       g_once_init_leave (&home_dir, tmp);
 955     }
 956
 957   return home_dir;
 958 }
 959
 960 /**
 961  * g_get_tmp_dir:
 962  *
 963  * Gets the directory to use for temporary files. This is found from
 964  * inspecting the environment variables <envar>TMPDIR</envar>,
 965  * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
 966  * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
 967  * The encoding of the returned string is system-defined. On Windows,
 968  * it is always UTF-8. The return value is never %NULL or the empty string.
 969  *
 970  * Returns: the directory to use for temporary files.
 971  */
 972 const gchar *
 973 g_get_tmp_dir (void)
 974 {
 975   static gchar *tmp_dir;
 976
 977   if (g_once_init_enter (&tmp_dir))
 978     {
 979       gchar *tmp;
 980
 981       tmp = g_strdup (g_getenv ("TMPDIR"));
 982
 983       if (tmp == NULL || *tmp == '\0')
 984         {
 985           g_free (tmp);
 986           tmp = g_strdup (g_getenv ("TMP"));
 987         }
 988
 989       if (tmp == NULL || *tmp == '\0')
 990         {
 991           g_free (tmp);
 992           tmp = g_strdup (g_getenv ("TEMP"));
 993         }
 994
 995 #ifdef G_OS_WIN32
 996       if (tmp == NULL || *tmp == '\0')
 997         {
 998           g_free (tmp);
 999           tmp = get_windows_directory_root ();
1000         }
1001 #else
1002
1003 #ifdef P_tmpdir
1004       if (tmp == NULL || *tmp == '\0')
1005         {
1006           gsize k;
1007           g_free (tmp);
1008           tmp = g_strdup (P_tmpdir);
1009           k = strlen (tmp);
1010           if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
1011             tmp[k - 1] = '\0';
1012         }
1013 #endif
1014
1015       if (tmp == NULL || *tmp == '\0')
1016         {
1017           g_free (tmp);
1018           tmp = g_strdup ("/tmp");
1019         }
1020 #endif /* !G_OS_WIN32 */
1021
1022       g_once_init_leave (&tmp_dir, tmp);
1023     }
1024
1025   return tmp_dir;
1026 }
1027
1028 /**
1029  * g_get_host_name:
1030  *
1031  * Return a name for the machine.
1032  *
1033  * The returned name is not necessarily a fully-qualified domain name,
1034  * or even present in DNS or some other name service at all. It need
1035  * not even be unique on your local network or site, but usually it
1036  * is. Callers should not rely on the return value having any specific
1037  * properties like uniqueness for security purposes. Even if the name
1038  * of the machine is changed while an application is running, the
1039  * return value from this function does not change. The returned
1040  * string is owned by GLib and should not be modified or freed. If no
1041  * name can be determined, a default fixed string "localhost" is
1042  * returned.
1043  *
1044  * Returns: the host name of the machine.
1045  *
1046  * Since: 2.8
1047  */
1048 const gchar *
1049 g_get_host_name (void)
1050 {
1051   static gchar *hostname;
1052
1053   if (g_once_init_enter (&hostname))
1054     {
1055       gboolean failed;
1056       gchar tmp[100];
1057
1058 #ifndef G_OS_WIN32
1059       failed = (gethostname (tmp, sizeof (tmp)) == -1);
1060 #else
1061       DWORD size = sizeof (tmp);
1062       failed = (!GetComputerName (tmp, &size));
1063 #endif
1064
1065       g_once_init_leave (&hostname, g_strdup (failed ? "localhost" : tmp));
1066     }
1067
1068   return hostname;
1069 }
1070
1071 G_LOCK_DEFINE_STATIC (g_prgname);
1072 static gchar *g_prgname = NULL;
1073
1074 /**
1075  * g_get_prgname:
1076  *
1077  * Gets the name of the program. This name should <emphasis>not</emphasis>
1078  * be localized, contrast with g_get_application_name().
1079  * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1080  * which is called by gtk_init(). The program name is found by taking
1081  * the last component of <literal>argv[0]</literal>.)
1082  *
1083  * Returns: the name of the program. The returned string belongs
1084  * to GLib and must not be modified or freed.
1085  */
1086 const gchar*
1087 g_get_prgname (void)
1088 {
1089   gchar* retval;
1090
1091   G_LOCK (g_prgname);
1092 #ifdef G_OS_WIN32
1093   if (g_prgname == NULL)
1094     {
1095       static gboolean beenhere = FALSE;
1096
1097       if (!beenhere)
1098         {
1099           gchar *utf8_buf = NULL;
1100           wchar_t buf[MAX_PATH+1];
1101
1102           beenhere = TRUE;
1103           if (GetModuleFileNameW (GetModuleHandle (NULL),
1104                                   buf, G_N_ELEMENTS (buf)) > 0)
1105             utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1106
1107           if (utf8_buf)
1108             {
1109               g_prgname = g_path_get_basename (utf8_buf);
1110               g_free (utf8_buf);
1111             }
1112         }
1113     }
1114 #endif
1115   retval = g_prgname;
1116   G_UNLOCK (g_prgname);
1117
1118   return retval;
1119 }
1120
1121 /**
1122  * g_set_prgname:
1123  * @prgname: the name of the program.
1124  *
1125  * Sets the name of the program. This name should <emphasis>not</emphasis>
1126  * be localized, contrast with g_set_application_name(). Note that for
1127  * thread-safety reasons this function can only be called once.
1128  */
1129 void
1130 g_set_prgname (const gchar *prgname)
1131 {
1132   G_LOCK (g_prgname);
1133   g_free (g_prgname);
1134   g_prgname = g_strdup (prgname);
1135   G_UNLOCK (g_prgname);
1136 }
1137
1138 G_LOCK_DEFINE_STATIC (g_application_name);
1139 static gchar *g_application_name = NULL;
1140
1141 /**
1142  * g_get_application_name:
1143  *
1144  * Gets a human-readable name for the application, as set by
1145  * g_set_application_name(). This name should be localized if
1146  * possible, and is intended for display to the user.  Contrast with
1147  * g_get_prgname(), which gets a non-localized name. If
1148  * g_set_application_name() has not been called, returns the result of
1149  * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1150  * been called).
1151  *
1152  * Return value: human-readable application name. may return %NULL
1153  *
1154  * Since: 2.2
1155  **/
1156 const gchar *
1157 g_get_application_name (void)
1158 {
1159   gchar* retval;
1160
1161   G_LOCK (g_application_name);
1162   retval = g_application_name;
1163   G_UNLOCK (g_application_name);
1164
1165   if (retval == NULL)
1166     return g_get_prgname ();
1167
1168   return retval;
1169 }
1170
1171 /**
1172  * g_set_application_name:
1173  * @application_name: localized name of the application
1174  *
1175  * Sets a human-readable name for the application. This name should be
1176  * localized if possible, and is intended for display to the user.
1177  * Contrast with g_set_prgname(), which sets a non-localized name.
1178  * g_set_prgname() will be called automatically by gtk_init(),
1179  * but g_set_application_name() will not.
1180  *
1181  * Note that for thread safety reasons, this function can only
1182  * be called once.
1183  *
1184  * The application name will be used in contexts such as error messages,
1185  * or when displaying an application's name in the task list.
1186  *
1187  * Since: 2.2
1188  **/
1189 void
1190 g_set_application_name (const gchar *application_name)
1191 {
1192   gboolean already_set = FALSE;
1193
1194   G_LOCK (g_application_name);
1195   if (g_application_name)
1196     already_set = TRUE;
1197   else
1198     g_application_name = g_strdup (application_name);
1199   G_UNLOCK (g_application_name);
1200
1201   if (already_set)
1202     g_warning ("g_set_application_name() called multiple times");
1203 }
1204
1205 /**
1206  * g_get_user_data_dir:
1207  *
1208  * Returns a base directory in which to access application data such
1209  * as icons that is customized for a particular user.
1210  *
1211  * On UNIX platforms this is determined using the mechanisms described in
1212  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1213  * XDG Base Directory Specification</ulink>.
1214  * In this case the directory retrieved will be XDG_DATA_HOME.
1215  *
1216  * On Windows this is the folder to use for local (as opposed to
1217  * roaming) application data. See documentation for
1218  * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1219  * what g_get_user_config_dir() returns.
1220  *
1221  * Return value: a string owned by GLib that must not be modified
1222  *               or freed.
1223  * Since: 2.6
1224  **/
1225 const gchar *
1226 g_get_user_data_dir (void)
1227 {
1228   gchar *data_dir;
1229
1230   G_LOCK (g_utils_global);
1231
1232   if (!g_user_data_dir)
1233     {
1234 #ifdef G_OS_WIN32
1235       data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1236 #else
1237       data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1238
1239       if (data_dir && data_dir[0])
1240         data_dir = g_strdup (data_dir);
1241 #endif
1242       if (!data_dir || !data_dir[0])
1243         {
1244           const gchar *home_dir = g_get_home_dir ();
1245
1246           if (home_dir)
1247             data_dir = g_build_filename (home_dir, ".local", "share", NULL);
1248           else
1249             data_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".local", "share", NULL);
1250         }
1251
1252       g_user_data_dir = data_dir;
1253     }
1254   else
1255     data_dir = g_user_data_dir;
1256
1257   G_UNLOCK (g_utils_global);
1258
1259   return data_dir;
1260 }
1261
1262 static void
1263 g_init_user_config_dir (void)
1264 {
1265   gchar *config_dir;
1266
1267   if (!g_user_config_dir)
1268     {
1269 #ifdef G_OS_WIN32
1270       config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1271 #else
1272       config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1273
1274       if (config_dir && config_dir[0])
1275         config_dir = g_strdup (config_dir);
1276 #endif
1277       if (!config_dir || !config_dir[0])
1278         {
1279           const gchar *home_dir = g_get_home_dir ();
1280
1281           if (home_dir)
1282             config_dir = g_build_filename (home_dir, ".config", NULL);
1283           else
1284             config_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".config", NULL);
1285         }
1286
1287       g_user_config_dir = config_dir;
1288     }
1289 }
1290
1291 /**
1292  * g_get_user_config_dir:
1293  *
1294  * Returns a base directory in which to store user-specific application
1295  * configuration information such as user preferences and settings.
1296  *
1297  * On UNIX platforms this is determined using the mechanisms described in
1298  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1299  * XDG Base Directory Specification</ulink>.
1300  * In this case the directory retrieved will be XDG_CONFIG_HOME.
1301  *
1302  * On Windows this is the folder to use for local (as opposed to
1303  * roaming) application data. See documentation for
1304  * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1305  * what g_get_user_data_dir() returns.
1306  *
1307  * Return value: a string owned by GLib that must not be modified
1308  *               or freed.
1309  * Since: 2.6
1310  **/
1311 const gchar *
1312 g_get_user_config_dir (void)
1313 {
1314   G_LOCK (g_utils_global);
1315
1316   g_init_user_config_dir ();
1317
1318   G_UNLOCK (g_utils_global);
1319
1320   return g_user_config_dir;
1321 }
1322
1323 /**
1324  * g_get_user_cache_dir:
1325  *
1326  * Returns a base directory in which to store non-essential, cached
1327  * data specific to particular user.
1328  *
1329  * On UNIX platforms this is determined using the mechanisms described in
1330  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1331  * XDG Base Directory Specification</ulink>.
1332  * In this case the directory retrieved will be XDG_CACHE_HOME.
1333  *
1334  * On Windows is the directory that serves as a common repository for
1335  * temporary Internet files. A typical path is
1336  * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1337  * See documentation for CSIDL_INTERNET_CACHE.
1338  *
1339  * Return value: a string owned by GLib that must not be modified
1340  *               or freed.
1341  * Since: 2.6
1342  **/
1343 const gchar *
1344 g_get_user_cache_dir (void)
1345 {
1346   gchar *cache_dir;
1347
1348   G_LOCK (g_utils_global);
1349
1350   if (!g_user_cache_dir)
1351     {
1352 #ifdef G_OS_WIN32
1353       cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1354 #else
1355       cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1356
1357       if (cache_dir && cache_dir[0])
1358           cache_dir = g_strdup (cache_dir);
1359 #endif
1360       if (!cache_dir || !cache_dir[0])
1361         {
1362           const gchar *home_dir = g_get_home_dir ();
1363
1364           if (home_dir)
1365             cache_dir = g_build_filename (home_dir, ".cache", NULL);
1366           else
1367             cache_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".cache", NULL);
1368         }
1369       g_user_cache_dir = cache_dir;
1370     }
1371   else
1372     cache_dir = g_user_cache_dir;
1373
1374   G_UNLOCK (g_utils_global);
1375
1376   return cache_dir;
1377 }
1378
1379 /**
1380  * g_get_user_runtime_dir:
1381  *
1382  * Returns a directory that is unique to the current user on the local
1383  * system.
1384  *
1385  * On UNIX platforms this is determined using the mechanisms described in
1386  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1387  * XDG Base Directory Specification</ulink>.  This is the directory
1388  * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
1389  * In the case that this variable is not set, GLib will issue a warning
1390  * message to stderr and return the value of g_get_user_cache_dir().
1391  *
1392  * On Windows this is the folder to use for local (as opposed to
1393  * roaming) application data. See documentation for
1394  * CSIDL_LOCAL_APPDATA.  Note that on Windows it thus is the same as
1395  * what g_get_user_config_dir() returns.
1396  *
1397  * Returns: a string owned by GLib that must not be modified or freed.
1398  *
1399  * Since: 2.28
1400  **/
1401 const gchar *
1402 g_get_user_runtime_dir (void)
1403 {
1404 #ifndef G_OS_WIN32
1405   static const gchar *runtime_dir;
1406   static gsize initialised;
1407
1408   if (g_once_init_enter (&initialised))
1409     {
1410       runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1411
1412       g_once_init_leave (&initialised, 1);
1413     }
1414
1415   if (runtime_dir)
1416     return runtime_dir;
1417
1418   /* Both fallback for UNIX and the default
1419    * in Windows: use the user cache directory.
1420    */
1421 #endif
1422
1423   return g_get_user_cache_dir ();
1424 }
1425
1426 #ifdef HAVE_CARBON
1427
1428 static gchar *
1429 find_folder (OSType type)
1430 {
1431   gchar *filename = NULL;
1432   FSRef  found;
1433
1434   if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1435     {
1436       CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1437
1438       if (url)
1439         {
1440           CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1441
1442           if (path)
1443             {
1444               filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1445
1446               if (! filename)
1447                 {
1448                   filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1449
1450                   CFStringGetCString (path, filename,
1451                                       CFStringGetLength (path) * 3 + 1,
1452                                       kCFStringEncodingUTF8);
1453                 }
1454
1455               CFRelease (path);
1456             }
1457
1458           CFRelease (url);
1459         }
1460     }
1461
1462   return filename;
1463 }
1464
1465 static void
1466 load_user_special_dirs (void)
1467 {
1468   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1469   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1470   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1471   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1472   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1473   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1474   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1475   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1476 }
1477
1478 #endif /* HAVE_CARBON */
1479
1480 #if defined(G_OS_WIN32)
1481 static void
1482 load_user_special_dirs (void)
1483 {
1484   typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1485                                                     DWORD dwFlags,
1486                                                     HANDLE hToken,
1487                                                     PWSTR *ppszPath);
1488   t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1489
1490   static const GUID FOLDERID_Downloads =
1491     { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1492   static const GUID FOLDERID_Public =
1493     { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1494
1495   wchar_t *wcp;
1496
1497   p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1498                                                                     "SHGetKnownFolderPath");
1499
1500   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1501   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1502
1503   if (p_SHGetKnownFolderPath == NULL)
1504     {
1505       g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1506     }
1507   else
1508     {
1509       wcp = NULL;
1510       (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1511       if (wcp)
1512         {
1513           g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1514           if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1515               g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1516           CoTaskMemFree (wcp);
1517         }
1518       else
1519           g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1520     }
1521
1522   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1523   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1524
1525   if (p_SHGetKnownFolderPath == NULL)
1526     {
1527       /* XXX */
1528       g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1529     }
1530   else
1531     {
1532       wcp = NULL;
1533       (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1534       if (wcp)
1535         {
1536           g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1537           if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1538               g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1539           CoTaskMemFree (wcp);
1540         }
1541       else
1542           g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1543     }
1544
1545   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1546   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1547 }
1548 #endif /* G_OS_WIN32 */
1549
1550 static void g_init_user_config_dir (void);
1551
1552 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1553
1554 /* adapted from xdg-user-dir-lookup.c
1555  *
1556  * Copyright (C) 2007 Red Hat Inc.
1557  *
1558  * Permission is hereby granted, free of charge, to any person
1559  * obtaining a copy of this software and associated documentation files
1560  * (the "Software"), to deal in the Software without restriction,
1561  * including without limitation the rights to use, copy, modify, merge,
1562  * publish, distribute, sublicense, and/or sell copies of the Software,
1563  * and to permit persons to whom the Software is furnished to do so,
1564  * subject to the following conditions:
1565  *
1566  * The above copyright notice and this permission notice shall be
1567  * included in all copies or substantial portions of the Software.
1568  *
1569  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1570  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1571  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1572  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1573  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1574  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1575  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1576  * SOFTWARE.
1577  */
1578 static void
1579 load_user_special_dirs (void)
1580 {
1581   gchar *config_file;
1582   gchar *data;
1583   gchar **lines;
1584   gint n_lines, i;
1585
1586   g_init_user_config_dir ();
1587   config_file = g_build_filename (g_user_config_dir,
1588                                   "user-dirs.dirs",
1589                                   NULL);
1590
1591   if (!g_file_get_contents (config_file, &data, NULL, NULL))
1592     {
1593       g_free (config_file);
1594       return;
1595     }
1596
1597   lines = g_strsplit (data, "\n", -1);
1598   n_lines = g_strv_length (lines);
1599   g_free (data);
1600
1601   for (i = 0; i < n_lines; i++)
1602     {
1603       gchar *buffer = lines[i];
1604       gchar *d, *p;
1605       gint len;
1606       gboolean is_relative = FALSE;
1607       GUserDirectory directory;
1608
1609       /* Remove newline at end */
1610       len = strlen (buffer);
1611       if (len > 0 && buffer[len - 1] == '\n')
1612         buffer[len - 1] = 0;
1613
1614       p = buffer;
1615       while (*p == ' ' || *p == '\t')
1616         p++;
1617
1618       if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1619         {
1620           directory = G_USER_DIRECTORY_DESKTOP;
1621           p += strlen ("XDG_DESKTOP_DIR");
1622         }
1623       else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1624         {
1625           directory = G_USER_DIRECTORY_DOCUMENTS;
1626           p += strlen ("XDG_DOCUMENTS_DIR");
1627         }
1628       else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1629         {
1630           directory = G_USER_DIRECTORY_DOWNLOAD;
1631           p += strlen ("XDG_DOWNLOAD_DIR");
1632         }
1633       else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1634         {
1635           directory = G_USER_DIRECTORY_MUSIC;
1636           p += strlen ("XDG_MUSIC_DIR");
1637         }
1638       else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1639         {
1640           directory = G_USER_DIRECTORY_PICTURES;
1641           p += strlen ("XDG_PICTURES_DIR");
1642         }
1643       else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1644         {
1645           directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1646           p += strlen ("XDG_PUBLICSHARE_DIR");
1647         }
1648       else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1649         {
1650           directory = G_USER_DIRECTORY_TEMPLATES;
1651           p += strlen ("XDG_TEMPLATES_DIR");
1652         }
1653       else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1654         {
1655           directory = G_USER_DIRECTORY_VIDEOS;
1656           p += strlen ("XDG_VIDEOS_DIR");
1657         }
1658       else
1659         continue;
1660
1661       while (*p == ' ' || *p == '\t')
1662         p++;
1663
1664       if (*p != '=')
1665         continue;
1666       p++;
1667
1668       while (*p == ' ' || *p == '\t')
1669         p++;
1670
1671       if (*p != '"')
1672         continue;
1673       p++;
1674
1675       if (strncmp (p, "$HOME", 5) == 0)
1676         {
1677           p += 5;
1678           is_relative = TRUE;
1679         }
1680       else if (*p != '/')
1681         continue;
1682
1683       d = strrchr (p, '"');
1684       if (!d)
1685         continue;
1686       *d = 0;
1687
1688       d = p;
1689
1690       /* remove trailing slashes */
1691       len = strlen (d);
1692       if (d[len - 1] == '/')
1693         d[len - 1] = 0;
1694
1695       if (is_relative)
1696         {
1697           g_user_special_dirs[directory] = g_build_filename (g_get_home_dir (), d, NULL);
1698         }
1699       else
1700         g_user_special_dirs[directory] = g_strdup (d);
1701     }
1702
1703   g_strfreev (lines);
1704   g_free (config_file);
1705 }
1706
1707 #endif /* G_OS_UNIX && !HAVE_CARBON */
1708
1709
1710 /**
1711  * g_reload_user_special_dirs_cache:
1712  *
1713  * Resets the cache used for g_get_user_special_dir(), so
1714  * that the latest on-disk version is used. Call this only
1715  * if you just changed the data on disk yourself.
1716  *
1717  * Due to threadsafety issues this may cause leaking of strings
1718  * that were previously returned from g_get_user_special_dir()
1719  * that can't be freed. We ensure to only leak the data for
1720  * the directories that actually changed value though.
1721  *
1722  * Since: 2.22
1723  */
1724 void
1725 g_reload_user_special_dirs_cache (void)
1726 {
1727   int i;
1728
1729   G_LOCK (g_utils_global);
1730
1731   if (g_user_special_dirs != NULL)
1732     {
1733       /* save a copy of the pointer, to check if some memory can be preserved */
1734       char **old_g_user_special_dirs = g_user_special_dirs;
1735       char *old_val;
1736
1737       /* recreate and reload our cache */
1738       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1739       load_user_special_dirs ();
1740
1741       /* only leak changed directories */
1742       for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1743         {
1744           old_val = old_g_user_special_dirs[i];
1745           if (g_user_special_dirs[i] == NULL)
1746             {
1747               g_user_special_dirs[i] = old_val;
1748             }
1749           else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1750             {
1751               /* don't leak */
1752               g_free (g_user_special_dirs[i]);
1753               g_user_special_dirs[i] = old_val;
1754             }
1755           else
1756             g_free (old_val);
1757         }
1758
1759       /* free the old array */
1760       g_free (old_g_user_special_dirs);
1761     }
1762
1763   G_UNLOCK (g_utils_global);
1764 }
1765
1766 /**
1767  * g_get_user_special_dir:
1768  * @directory: the logical id of special directory
1769  *
1770  * Returns the full path of a special directory using its logical id.
1771  *
1772  * On Unix this is done using the XDG special user directories.
1773  * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1774  * falls back to <filename>$HOME/Desktop</filename> when XDG special
1775  * user directories have not been set up.
1776  *
1777  * Depending on the platform, the user might be able to change the path
1778  * of the special directory without requiring the session to restart; GLib
1779  * will not reflect any change once the special directories are loaded.
1780  *
1781  * Return value: the path to the specified special directory, or %NULL
1782  *   if the logical id was not found. The returned string is owned by
1783  *   GLib and should not be modified or freed.
1784  *
1785  * Since: 2.14
1786  */
1787 const gchar *
1788 g_get_user_special_dir (GUserDirectory directory)
1789 {
1790   g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1791                         directory < G_USER_N_DIRECTORIES, NULL);
1792
1793   G_LOCK (g_utils_global);
1794
1795   if (G_UNLIKELY (g_user_special_dirs == NULL))
1796     {
1797       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1798
1799       load_user_special_dirs ();
1800
1801       /* Special-case desktop for historical compatibility */
1802       if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1803         g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (g_get_home_dir (), "Desktop", NULL);
1804     }
1805
1806   G_UNLOCK (g_utils_global);
1807
1808   return g_user_special_dirs[directory];
1809 }
1810
1811 #ifdef G_OS_WIN32
1812
1813 #undef g_get_system_data_dirs
1814
1815 static HMODULE
1816 get_module_for_address (gconstpointer address)
1817 {
1818   /* Holds the g_utils_global lock */
1819
1820   static gboolean beenhere = FALSE;
1821   typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1822   static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1823   HMODULE hmodule = NULL;
1824
1825   if (!address)
1826     return NULL;
1827
1828   if (!beenhere)
1829     {
1830       p_GetModuleHandleExA =
1831         (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1832                                                "GetModuleHandleExA");
1833       beenhere = TRUE;
1834     }
1835
1836   if (p_GetModuleHandleExA == NULL ||
1837       !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1838                                 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1839                                 address, &hmodule))
1840     {
1841       MEMORY_BASIC_INFORMATION mbi;
1842       VirtualQuery (address, &mbi, sizeof (mbi));
1843       hmodule = (HMODULE) mbi.AllocationBase;
1844     }
1845
1846   return hmodule;
1847 }
1848
1849 static gchar *
1850 get_module_share_dir (gconstpointer address)
1851 {
1852   HMODULE hmodule;
1853   gchar *filename;
1854   gchar *retval;
1855
1856   hmodule = get_module_for_address (address);
1857   if (hmodule == NULL)
1858     return NULL;
1859
1860   filename = g_win32_get_package_installation_directory_of_module (hmodule);
1861   retval = g_build_filename (filename, "share", NULL);
1862   g_free (filename);
1863
1864   return retval;
1865 }
1866
1867 const gchar * const *
1868 g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
1869 {
1870   GArray *data_dirs;
1871   HMODULE hmodule;
1872   static GHashTable *per_module_data_dirs = NULL;
1873   gchar **retval;
1874   gchar *p;
1875   gchar *exe_root;
1876
1877   if (address_of_function)
1878     {
1879       G_LOCK (g_utils_global);
1880       hmodule = get_module_for_address (address_of_function);
1881       if (hmodule != NULL)
1882         {
1883           if (per_module_data_dirs == NULL)
1884             per_module_data_dirs = g_hash_table_new (NULL, NULL);
1885           else
1886             {
1887               retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1888
1889               if (retval != NULL)
1890                 {
1891                   G_UNLOCK (g_utils_global);
1892                   return (const gchar * const *) retval;
1893                 }
1894             }
1895         }
1896     }
1897
1898   data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1899
1900   /* Documents and Settings\All Users\Application Data */
1901   p = get_special_folder (CSIDL_COMMON_APPDATA);
1902   if (p)
1903     g_array_append_val (data_dirs, p);
1904
1905   /* Documents and Settings\All Users\Documents */
1906   p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1907   if (p)
1908     g_array_append_val (data_dirs, p);
1909
1910   /* Using the above subfolders of Documents and Settings perhaps
1911    * makes sense from a Windows perspective.
1912    *
1913    * But looking at the actual use cases of this function in GTK+
1914    * and GNOME software, what we really want is the "share"
1915    * subdirectory of the installation directory for the package
1916    * our caller is a part of.
1917    *
1918    * The address_of_function parameter, if non-NULL, points to a
1919    * function in the calling module. Use that to determine that
1920    * module's installation folder, and use its "share" subfolder.
1921    *
1922    * Additionally, also use the "share" subfolder of the installation
1923    * locations of GLib and the .exe file being run.
1924    *
1925    * To guard against none of the above being what is really wanted,
1926    * callers of this function should have Win32-specific code to look
1927    * up their installation folder themselves, and handle a subfolder
1928    * "share" of it in the same way as the folders returned from this
1929    * function.
1930    */
1931
1932   p = get_module_share_dir (address_of_function);
1933   if (p)
1934     g_array_append_val (data_dirs, p);
1935
1936   if (glib_dll != NULL)
1937     {
1938       gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1939       p = g_build_filename (glib_root, "share", NULL);
1940       if (p)
1941         g_array_append_val (data_dirs, p);
1942       g_free (glib_root);
1943     }
1944
1945   exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1946   p = g_build_filename (exe_root, "share", NULL);
1947   if (p)
1948     g_array_append_val (data_dirs, p);
1949   g_free (exe_root);
1950
1951   retval = (gchar **) g_array_free (data_dirs, FALSE);
1952
1953   if (address_of_function)
1954     {
1955       if (hmodule != NULL)
1956         g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1957       G_UNLOCK (g_utils_global);
1958     }
1959
1960   return (const gchar * const *) retval;
1961 }
1962
1963 #endif
1964
1965 /**
1966  * g_get_system_data_dirs:
1967  *
1968  * Returns an ordered list of base directories in which to access
1969  * system-wide application data.
1970  *
1971  * On UNIX platforms this is determined using the mechanisms described in
1972  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1973  * XDG Base Directory Specification</ulink>
1974  * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1975  *
1976  * On Windows the first elements in the list are the Application Data
1977  * and Documents folders for All Users. (These can be determined only
1978  * on Windows 2000 or later and are not present in the list on other
1979  * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1980  * CSIDL_COMMON_DOCUMENTS.
1981  *
1982  * Then follows the "share" subfolder in the installation folder for
1983  * the package containing the DLL that calls this function, if it can
1984  * be determined.
1985  *
1986  * Finally the list contains the "share" subfolder in the installation
1987  * folder for GLib, and in the installation folder for the package the
1988  * application's .exe file belongs to.
1989  *
1990  * The installation folders above are determined by looking up the
1991  * folder where the module (DLL or EXE) in question is located. If the
1992  * folder's name is "bin", its parent is used, otherwise the folder
1993  * itself.
1994  *
1995  * Note that on Windows the returned list can vary depending on where
1996  * this function is called.
1997  *
1998  * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1999  *               not be modified or freed.
2000  * Since: 2.6
2001  **/
2002 const gchar * const *
2003 g_get_system_data_dirs (void)
2004 {
2005   gchar **data_dir_vector;
2006
2007   G_LOCK (g_utils_global);
2008
2009   if (!g_system_data_dirs)
2010     {
2011 #ifdef G_OS_WIN32
2012       data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2013 #else
2014       gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2015
2016       if (!data_dirs || !data_dirs[0])
2017           data_dirs = "/usr/local/share/:/usr/share/";
2018
2019       data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2020 #endif
2021
2022       g_system_data_dirs = data_dir_vector;
2023     }
2024   else
2025     data_dir_vector = g_system_data_dirs;
2026
2027   G_UNLOCK (g_utils_global);
2028
2029   return (const gchar * const *) data_dir_vector;
2030 }
2031
2032 /**
2033  * g_get_system_config_dirs:
2034  *
2035  * Returns an ordered list of base directories in which to access
2036  * system-wide configuration information.
2037  *
2038  * On UNIX platforms this is determined using the mechanisms described in
2039  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2040  * XDG Base Directory Specification</ulink>.
2041  * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2042  *
2043  * On Windows is the directory that contains application data for all users.
2044  * A typical path is C:\Documents and Settings\All Users\Application Data.
2045  * This folder is used for application data that is not user specific.
2046  * For example, an application can store a spell-check dictionary, a database
2047  * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2048  * This information will not roam and is available to anyone using the computer.
2049  *
2050  * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2051  *               not be modified or freed.
2052  * Since: 2.6
2053  **/
2054 const gchar * const *
2055 g_get_system_config_dirs (void)
2056 {
2057   gchar *conf_dirs, **conf_dir_vector;
2058
2059   G_LOCK (g_utils_global);
2060
2061   if (!g_system_config_dirs)
2062     {
2063 #ifdef G_OS_WIN32
2064       conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2065       if (conf_dirs)
2066         {
2067           conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2068           g_free (conf_dirs);
2069         }
2070       else
2071         {
2072           /* Return empty list */
2073           conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2074         }
2075 #else
2076       conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2077
2078       if (!conf_dirs || !conf_dirs[0])
2079           conf_dirs = "/etc/xdg";
2080
2081       conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2082 #endif
2083
2084       g_system_config_dirs = conf_dir_vector;
2085     }
2086   else
2087     conf_dir_vector = g_system_config_dirs;
2088   G_UNLOCK (g_utils_global);
2089
2090   return (const gchar * const *) conf_dir_vector;
2091 }
2092
2093 /**
2094  * g_nullify_pointer:
2095  * @nullify_location: the memory address of the pointer.
2096  *
2097  * Set the pointer at the specified location to %NULL.
2098  **/
2099 void
2100 g_nullify_pointer (gpointer *nullify_location)
2101 {
2102   g_return_if_fail (nullify_location != NULL);
2103
2104   *nullify_location = NULL;
2105 }
2106
2107 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2108 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2109 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2110 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2111 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2112 #define EXABYTE_FACTOR  (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2113
2114 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2115 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2116 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2117 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2118 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2119 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2120
2121 /**
2122  * g_format_size:
2123  * @size: a size in bytes
2124  *
2125  * Formats a size (for example the size of a file) into a human readable
2126  * string.  Sizes are rounded to the nearest size prefix (kB, MB, GB)
2127  * and are displayed rounded to the nearest tenth. E.g. the file size
2128  * 3292528 bytes will be converted into the string "3.2 MB".
2129  *
2130  * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2131  *
2132  * This string should be freed with g_free() when not needed any longer.
2133  *
2134  * See g_format_size_full() for more options about how the size might be
2135  * formatted.
2136  *
2137  * Returns: a newly-allocated formatted string containing a human readable
2138  *     file size
2139  *
2140  * Since: 2.30
2141  */
2142 gchar *
2143 g_format_size (guint64 size)
2144 {
2145   return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2146 }
2147
2148 /**
2149  * GFormatSizeFlags:
2150  * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2151  * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2152  *     of the returned string.  For example, "45.6 kB (45,612 bytes)".
2153  * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2154  *     suffixes. IEC units should only be used for reporting things with
2155  *     a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2156  *     Network and storage sizes should be reported in the normal SI units.
2157  *
2158  * Flags to modify the format of the string returned by g_format_size_full().
2159  */
2160
2161 /**
2162  * g_format_size_full:
2163  * @size: a size in bytes
2164  * @flags: #GFormatSizeFlags to modify the output
2165  *
2166  * Formats a size.
2167  *
2168  * This function is similar to g_format_size() but allows for flags
2169  * that modify the output. See #GFormatSizeFlags.
2170  *
2171  * Returns: a newly-allocated formatted string containing a human
2172  *     readable file size
2173  *
2174  * Since: 2.30
2175  */
2176 gchar *
2177 g_format_size_full (guint64          size,
2178                     GFormatSizeFlags flags)
2179 {
2180   GString *string;
2181
2182   string = g_string_new (NULL);
2183
2184   if (flags & G_FORMAT_SIZE_IEC_UNITS)
2185     {
2186       if (size < KIBIBYTE_FACTOR)
2187         {
2188           g_string_printf (string,
2189                            g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2190                            (guint) size);
2191           flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2192         }
2193
2194       else if (size < MEBIBYTE_FACTOR)
2195         g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2196       else if (size < GIBIBYTE_FACTOR)
2197         g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2198
2199       else if (size < TEBIBYTE_FACTOR)
2200         g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2201
2202       else if (size < PEBIBYTE_FACTOR)
2203         g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2204
2205       else if (size < EXBIBYTE_FACTOR)
2206         g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2207
2208       else
2209         g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2210     }
2211   else
2212     {
2213       if (size < KILOBYTE_FACTOR)
2214         {
2215           g_string_printf (string,
2216                            g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2217                            (guint) size);
2218           flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2219         }
2220
2221       else if (size < MEGABYTE_FACTOR)
2222         g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2223
2224       else if (size < GIGABYTE_FACTOR)
2225         g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2226
2227       else if (size < TERABYTE_FACTOR)
2228         g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2229       else if (size < PETABYTE_FACTOR)
2230         g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2231
2232       else if (size < EXABYTE_FACTOR)
2233         g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2234
2235       else
2236         g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2237     }
2238
2239   if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2240     {
2241       /* First problem: we need to use the number of bytes to decide on
2242        * the plural form that is used for display, but the number of
2243        * bytes potentially exceeds the size of a guint (which is what
2244        * ngettext() takes).
2245        *
2246        * From a pragmatic standpoint, it seems that all known languages
2247        * base plural forms on one or both of the following:
2248        *
2249        *   - the lowest digits of the number
2250        *
2251        *   - if the number if greater than some small value
2252        *
2253        * Here's how we fake it:  Draw an arbitrary line at one thousand.
2254        * If the number is below that, then fine.  If it is above it,
2255        * then we take the modulus of the number by one thousand (in
2256        * order to keep the lowest digits) and add one thousand to that
2257        * (in order to ensure that 1001 is not treated the same as 1).
2258        */
2259       guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2260
2261       /* Second problem: we need to translate the string "%u byte" and
2262        * "%u bytes" for pluralisation, but the correct number format to
2263        * use for a gsize is different depending on which architecture
2264        * we're on.
2265        *
2266        * Solution: format the number separately and use "%s bytes" on
2267        * all platforms.
2268        */
2269       const gchar *translated_format;
2270       gchar *formatted_number;
2271
2272       /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2273       translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2274       /* XXX: Windows doesn't support the "'" format modifier, so we
2275        * must not use it there.  Instead, just display the number
2276        * without separation.  Bug #655336 is open until a solution is
2277        * found.
2278        */
2279 #ifndef G_OS_WIN32
2280       formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2281 #else
2282       formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2283 #endif
2284
2285       g_string_append (string, " (");
2286       g_string_append_printf (string, translated_format, formatted_number);
2287       g_free (formatted_number);
2288       g_string_append (string, ")");
2289     }
2290
2291   return g_string_free (string, FALSE);
2292 }
2293
2294 /**
2295  * g_format_size_for_display:
2296  * @size: a size in bytes
2297  *
2298  * Formats a size (for example the size of a file) into a human
2299  * readable string. Sizes are rounded to the nearest size prefix
2300  * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2301  * E.g. the file size 3292528 bytes will be converted into the
2302  * string "3.1 MB".
2303  *
2304  * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2305  *
2306  * This string should be freed with g_free() when not needed any longer.
2307  *
2308  * Returns: a newly-allocated formatted string containing a human
2309  *     readable file size
2310  *
2311  * Since: 2.16
2312  *
2313  * Deprecated:2.30: This function is broken due to its use of SI
2314  *     suffixes to denote IEC units. Use g_format_size() instead.
2315  */
2316 gchar *
2317 g_format_size_for_display (goffset size)
2318 {
2319   if (size < (goffset) KIBIBYTE_FACTOR)
2320     return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2321   else
2322     {
2323       gdouble displayed_size;
2324
2325       if (size < (goffset) MEBIBYTE_FACTOR)
2326         {
2327           displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2328           /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
2329            * mean 1024 bytes.  I am aware that 'KB' is not correct, but it has been preserved for reasons of
2330            * compatibility.  Users will not see this string unless a program is using this deprecated function.
2331            * Please translate as literally as possible.
2332            */
2333           return g_strdup_printf (_("%.1f KB"), displayed_size);
2334         }
2335       else if (size < (goffset) GIBIBYTE_FACTOR)
2336         {
2337           displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2338           return g_strdup_printf (_("%.1f MB"), displayed_size);
2339         }
2340       else if (size < (goffset) TEBIBYTE_FACTOR)
2341         {
2342           displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2343           return g_strdup_printf (_("%.1f GB"), displayed_size);
2344         }
2345       else if (size < (goffset) PEBIBYTE_FACTOR)
2346         {
2347           displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2348           return g_strdup_printf (_("%.1f TB"), displayed_size);
2349         }
2350       else if (size < (goffset) EXBIBYTE_FACTOR)
2351         {
2352           displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2353           return g_strdup_printf (_("%.1f PB"), displayed_size);
2354         }
2355       else
2356         {
2357           displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2358           return g_strdup_printf (_("%.1f EB"), displayed_size);
2359         }
2360     }
2361 }
2362
2363 #if defined (G_OS_WIN32) && !defined (_WIN64)
2364
2365 /* Binary compatibility versions. Not for newly compiled code. */
2366
2367 _GLIB_EXTERN const gchar *g_get_user_name_utf8        (void);
2368 _GLIB_EXTERN const gchar *g_get_real_name_utf8        (void);
2369 _GLIB_EXTERN const gchar *g_get_home_dir_utf8         (void);
2370 _GLIB_EXTERN const gchar *g_get_tmp_dir_utf8          (void);
2371 _GLIB_EXTERN gchar       *g_find_program_in_path_utf8 (const gchar *program);
2372
2373 gchar *
2374 g_find_program_in_path_utf8 (const gchar *program)
2375 {
2376   return g_find_program_in_path (program);
2377 }
2378
2379 const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
2380 const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
2381 const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
2382 const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
2383
2384 #endif
2385
2386 /* Private API:
2387  *
2388  * Returns %TRUE if the current process was executed as setuid (or an
2389  * equivalent __libc_enable_secure is available).  See:
2390  * http://osdir.com/ml/linux.lfs.hardened/2007-04/msg00032.html
2391  */
2392 gboolean
2393 g_check_setuid (void)
2394 {
2395   /* TODO: get __libc_enable_secure exported from glibc.
2396    * See http://www.openwall.com/lists/owl-dev/2012/08/14/1
2397    */
2398 #if 0 && defined(HAVE_LIBC_ENABLE_SECURE)
2399   {
2400     /* See glibc/include/unistd.h */
2401     extern int __libc_enable_secure;
2402     return __libc_enable_secure;
2403   }
2404 #elif defined(HAVE_ISSETUGID)
2405   /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
2406   return issetugid ();
2407 #elif defined(G_OS_UNIX)
2408   uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
2409   gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
2410
2411   static gsize check_setuid_initialised;
2412   static gboolean is_setuid;
2413
2414   if (g_once_init_enter (&check_setuid_initialised))
2415     {
2416 #ifdef HAVE_GETRESUID
2417       /* These aren't in the header files, so we prototype them here.
2418        */
2419       int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
2420       int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
2421
2422       if (getresuid (&ruid, &euid, &suid) != 0 ||
2423           getresgid (&rgid, &egid, &sgid) != 0)
2424 #endif /* HAVE_GETRESUID */
2425         {
2426           suid = ruid = getuid ();
2427           sgid = rgid = getgid ();
2428           euid = geteuid ();
2429           egid = getegid ();
2430         }
2431
2432       is_setuid = (ruid != euid || ruid != suid ||
2433                    rgid != egid || rgid != sgid);
2434
2435       g_once_init_leave (&check_setuid_initialised, 1);
2436     }
2437   return is_setuid;
2438 #else
2439   return FALSE;
2440 #endif
2441 }