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