1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1998 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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/>.
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/.
26 * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
32 #include "gutilsprivate.h"
39 #include <ctype.h> /* For tolower() */
41 #include <sys/types.h>
47 #include <sys/types.h>
48 #ifdef HAVE_SYS_PARAM_H
49 #include <sys/param.h>
51 #ifdef HAVE_CRT_EXTERNS_H
52 #include <crt_externs.h> /* for _NSGetEnviron */
54 #ifdef HAVE_SYS_AUXV_H
58 #include "glib-init.h"
59 #include "glib-private.h"
61 #include "gfileutils.h"
65 #include "gtestutils.h"
67 #include "gstrfuncs.h"
72 #ifdef G_PLATFORM_WIN32
80 * @title: Miscellaneous Utility Functions
81 * @short_description: a selection of portable utility functions
83 * These are portable utility functions.
86 #ifdef G_PLATFORM_WIN32
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
92 # include <lmcons.h> /* For UNLEN */
93 #endif /* G_PLATFORM_WIN32 */
98 /* older SDK (e.g. msvc 5.0) does not have these*/
99 # ifndef CSIDL_MYMUSIC
100 # define CSIDL_MYMUSIC 13
102 # ifndef CSIDL_MYVIDEO
103 # define CSIDL_MYVIDEO 14
105 # ifndef CSIDL_INTERNET_CACHE
106 # define CSIDL_INTERNET_CACHE 32
108 # ifndef CSIDL_COMMON_APPDATA
109 # define CSIDL_COMMON_APPDATA 35
111 # ifndef CSIDL_MYPICTURES
112 # define CSIDL_MYPICTURES 0x27
114 # ifndef CSIDL_COMMON_DOCUMENTS
115 # define CSIDL_COMMON_DOCUMENTS 46
117 # ifndef CSIDL_PROFILE
118 # define CSIDL_PROFILE 40
120 # include <process.h>
124 #include <langinfo.h>
127 #ifdef G_PLATFORM_WIN32
130 _glib_get_dll_directory (void)
134 wchar_t wc_fn[MAX_PATH];
137 if (glib_dll == NULL)
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.
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.
150 if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
153 retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
155 p = strrchr (retval, G_DIR_SEPARATOR);
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.
174 * Copies a block of memory @len bytes long, from @src to @dest.
175 * The source and destination areas may overlap.
177 * Deprecated:2.40: Just use memmove().
186 * @func: (scope async): the function to call on normal program termination.
188 * Specifies a function to be called at normal program termination.
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
199 * The behaviour of atexit() in the context of dynamically loaded
200 * modules is not formally specified and varies wildly.
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.
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.
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.
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
219 * Deprecated:2.32: It is best to avoid g_atexit().
222 g_atexit (GVoidFunc func)
227 result = atexit ((void (*)(void)) func);
231 g_error ("Could not register atexit() function: %s",
236 /* Based on execvp() from GNU Libc.
237 * Some of this code is cut-and-pasted into gspawn.c
241 my_strchrnul (const gchar *str,
244 gchar *p = (gchar*)str;
245 while (*p && (*p != c))
253 static gchar *inner_find_program_in_path (const gchar *program);
256 g_find_program_in_path (const gchar *program)
258 const gchar *last_dot = strrchr (program, '.');
260 if (last_dot == NULL ||
261 strchr (last_dot, '\\') != NULL ||
262 strchr (last_dot, '/') != NULL)
264 const gint program_length = strlen (program);
265 gchar *pathext = g_build_path (";",
266 ".exe;.cmd;.bat;.com",
267 g_getenv ("PATHEXT"),
270 gchar *decorated_program;
276 gchar *q = my_strchrnul (p, ';');
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';
283 retval = inner_find_program_in_path (decorated_program);
284 g_free (decorated_program);
292 } while (*p++ != '\0');
297 return inner_find_program_in_path (program);
303 * g_find_program_in_path:
304 * @program: (type filename): a program name in the GLib file name encoding
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.
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.
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.
324 * Returns: (type filename): a newly-allocated string with the absolute path,
329 inner_find_program_in_path (const gchar *program)
332 g_find_program_in_path (const gchar *program)
335 const gchar *path, *p;
336 gchar *name, *freeme;
338 const gchar *path_copy;
339 gchar *filename = NULL, *appdir = NULL;
340 gchar *sysdir = NULL, *windir = NULL;
342 wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
348 g_return_val_if_fail (program != NULL, NULL);
350 /* If it is an absolute path, or a relative path including subdirectories,
351 * don't look in PATH.
353 if (g_path_is_absolute (program)
354 || strchr (program, G_DIR_SEPARATOR) != NULL
356 || strchr (program, '/') != NULL
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);
367 path = g_getenv ("PATH");
368 #if defined(G_OS_UNIX)
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'.
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.
381 path = "/bin:/usr/bin:.";
384 n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
385 if (n > 0 && n < MAXPATHLEN)
386 filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
388 n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
389 if (n > 0 && n < MAXPATHLEN)
390 sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
392 n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
393 if (n > 0 && n < MAXPATHLEN)
394 windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
398 appdir = g_path_get_dirname (filename);
402 path = g_strdup (path);
406 const gchar *tem = path;
407 path = g_strconcat (windir, ";", path, NULL);
408 g_free ((gchar *) tem);
414 const gchar *tem = path;
415 path = g_strconcat (sysdir, ";", path, NULL);
416 g_free ((gchar *) tem);
421 const gchar *tem = path;
422 path = g_strconcat (".;", path, NULL);
423 g_free ((gchar *) tem);
428 const gchar *tem = path;
429 path = g_strconcat (appdir, ";", path, NULL);
430 g_free ((gchar *) tem);
437 len = strlen (program) + 1;
438 pathlen = strlen (path);
439 freeme = name = g_malloc (pathlen + len + 1);
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;
453 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
456 /* Two adjacent colons, or a colon at the beginning or the end
457 * of 'PATH' means to search the current directory.
461 startp = memcpy (name - (p - path), path, p - path);
463 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
464 !g_file_test (startp, G_FILE_TEST_IS_DIR))
467 ret = g_strdup (startp);
470 g_free ((gchar *) path_copy);
475 while (*p++ != '\0');
479 g_free ((gchar *) path_copy);
485 /* The functions below are defined this way for compatibility reasons.
486 * See the note in gutils.h.
491 * @mask: a #gulong containing flags
492 * @nth_bit: the index of the bit to start the search from
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.
499 * Returns: the index of the first bit set which is higher than @nth_bit, or -1
500 * if no higher bits are set
503 (g_bit_nth_lsf) (gulong mask,
506 return g_bit_nth_lsf_impl (mask, nth_bit);
511 * @mask: a #gulong containing flags
512 * @nth_bit: the index of the bit to start the search from
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.
520 * Returns: the index of the first bit set which is lower than @nth_bit, or -1
521 * if no lower bits are set
524 (g_bit_nth_msf) (gulong mask,
527 return g_bit_nth_msf_impl (mask, nth_bit);
535 * Gets the number of bits used to hold @number,
536 * e.g. if @number is 4, 3 bits are needed.
538 * Returns: the number of bits used to hold @number
541 (g_bit_storage) (gulong number)
543 return g_bit_storage_impl (number);
546 G_LOCK_DEFINE_STATIC (g_utils_global);
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;
564 /* fifteen minutes of fame for everybody */
565 #define G_USER_DIRS_EXPIRE 15 * 60
570 get_special_folder (int csidl)
572 wchar_t path[MAX_PATH+1];
574 LPITEMIDLIST pidl = NULL;
576 gchar *retval = NULL;
578 hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
581 b = SHGetPathFromIDListW (pidl, path);
583 retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
584 CoTaskMemFree (pidl);
590 get_windows_directory_root (void)
592 wchar_t wwindowsdir[MAX_PATH];
594 if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
596 /* Usually X:\Windows, but in terminal server environments
597 * might be an UNC path, AFAIK.
599 char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
602 if (windowsdir == NULL)
603 return g_strdup ("C:\\");
605 p = (char *) g_path_skip_root (windowsdir);
606 if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
612 return g_strdup ("C:\\");
617 /* HOLDS: g_utils_global_lock */
618 static UserDatabaseEntry *
619 g_get_user_database_entry (void)
621 static UserDatabaseEntry *entry;
623 if (g_once_init_enter (&entry))
625 static UserDatabaseEntry e;
629 struct passwd *pw = NULL;
630 gpointer buffer = NULL;
634 # if defined (HAVE_GETPWUID_R)
636 # ifdef _SC_GETPW_R_SIZE_MAX
637 /* This reurns the maximum length */
638 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
642 # else /* _SC_GETPW_R_SIZE_MAX */
644 # endif /* _SC_GETPW_R_SIZE_MAX */
646 logname = (gchar *) g_getenv ("LOGNAME");
651 /* we allocate 6 extra bytes to work around a bug in
652 * Mac OS < 10.3. See #156446
654 buffer = g_malloc (bufsize + 6);
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);
664 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
666 error = error < 0 ? errno : error;
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
675 if (error == 0 || error == ENOENT)
677 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
681 if (bufsize > 32 * 1024)
683 g_warning ("getpwuid_r(): failed due to: %s.",
692 # endif /* HAVE_GETPWUID_R */
696 pw = getpwuid (getuid ());
700 e.user_name = g_strdup (pw->pw_name);
703 if (pw->pw_gecos && *pw->pw_gecos != '\0')
705 gchar **gecos_fields;
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);
719 e.home_dir = g_strdup (pw->pw_dir);
724 #endif /* G_OS_UNIX */
729 wchar_t buffer[UNLEN+1];
731 if (GetUserNameW (buffer, (LPDWORD) &len))
733 e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
734 e.real_name = g_strdup (e.user_name);
737 #endif /* G_OS_WIN32 */
740 e.user_name = g_strdup ("somebody");
742 e.real_name = g_strdup ("Unknown");
744 g_once_init_leave (&entry, &e);
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.
758 * Returns: (type filename): the user name of the current user.
761 g_get_user_name (void)
763 UserDatabaseEntry *entry;
765 entry = g_get_user_database_entry ();
767 return entry->user_name;
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
779 * Returns: (type filename): the user's real name.
782 g_get_real_name (void)
784 UserDatabaseEntry *entry;
786 entry = g_get_user_database_entry ();
788 return entry->real_name;
791 /* Protected by @g_utils_global_lock. */
792 static gchar *g_home_dir = NULL; /* (owned) (nullable before initialised) */
795 g_build_home_dir (void)
799 /* We first check HOME and use it if it is set */
800 home_dir = g_strdup (g_getenv ("HOME"));
803 /* Only believe HOME if it is an absolute path and exists.
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...
811 if (home_dir != NULL)
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);
818 /* In case HOME is Unix-style (it happens), convert it to
821 if (home_dir != NULL)
824 while ((p = strchr (home_dir, '/')) != NULL)
828 if (home_dir == NULL)
830 /* USERPROFILE is probably the closest equivalent to $HOME? */
831 if (g_getenv ("USERPROFILE") != NULL)
832 home_dir = g_strdup (g_getenv ("USERPROFILE"));
835 if (home_dir == NULL)
836 home_dir = get_special_folder (CSIDL_PROFILE);
838 if (home_dir == NULL)
839 home_dir = get_windows_directory_root ();
840 #endif /* G_OS_WIN32 */
842 if (home_dir == NULL)
844 /* If we didn't get it from any of those methods, we will have
845 * to read the user database entry.
847 UserDatabaseEntry *entry = g_get_user_database_entry ();
848 home_dir = g_strdup (entry->home_dir);
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)
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 ("/");
861 return g_steal_pointer (&home_dir);
867 * Gets the current user's home directory.
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.
873 * If the path given in `HOME` is non-absolute, does not exist, or is
874 * not a directory, the result is undefined.
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).
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.
888 * Returns: (type filename): the current user's home directory
891 g_get_home_dir (void)
893 const gchar *home_dir;
895 G_LOCK (g_utils_global);
897 if (g_home_dir == NULL)
898 g_home_dir = g_build_home_dir ();
899 home_dir = g_home_dir;
901 G_UNLOCK (g_utils_global);
909 * Gets the directory to use for temporary files.
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.
916 * On Windows, the `TEMP` environment variable is used, with the
917 * root directory of the Windows installation (eg: "C:\") used
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
924 * Returns: (type filename): the directory to use for temporary files.
929 static gchar *tmp_dir;
931 if (g_once_init_enter (&tmp_dir))
936 tmp = g_strdup (g_getenv ("TEMP"));
938 if (tmp == NULL || *tmp == '\0')
941 tmp = get_windows_directory_root ();
943 #else /* G_OS_WIN32 */
944 tmp = g_strdup (g_getenv ("TMPDIR"));
947 if (tmp == NULL || *tmp == '\0')
951 tmp = g_strdup (P_tmpdir);
953 if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
956 #endif /* P_tmpdir */
958 if (tmp == NULL || *tmp == '\0')
961 tmp = g_strdup ("/tmp");
963 #endif /* !G_OS_WIN32 */
965 g_once_init_leave (&tmp_dir, tmp);
974 * Return a name for the machine.
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
987 * The encoding of the returned string is UTF-8.
989 * Returns: the host name of the machine.
994 g_get_host_name (void)
996 static gchar *hostname;
998 if (g_once_init_enter (&hostname))
1004 gchar *tmp = g_malloc (sizeof (gchar) * 100);
1005 failed = (gethostname (tmp, sizeof (gchar) * 100) == -1);
1007 g_clear_pointer (&tmp, g_free);
1010 wchar_t tmp[MAX_COMPUTERNAME_LENGTH + 1];
1011 DWORD size = sizeof (tmp) / sizeof (tmp[0]);
1012 failed = (!GetComputerNameW (tmp, &size));
1014 utmp = g_utf16_to_utf8 (tmp, size, NULL, NULL, NULL);
1019 g_once_init_leave (&hostname, failed ? g_strdup ("localhost") : utmp);
1025 G_LOCK_DEFINE_STATIC (g_prgname);
1026 static gchar *g_prgname = NULL;
1031 * Gets the name of the program. This name should not be localized,
1032 * in contrast to g_get_application_name().
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].
1040 * Returns: (nullable): the name of the program, or %NULL if it has not been
1041 * set yet. The returned string belongs
1042 * to GLib and must not be modified or freed.
1045 g_get_prgname (void)
1051 G_UNLOCK (g_prgname);
1058 * @prgname: the name of the program.
1060 * Sets the name of the program. This name should not be localized,
1061 * in contrast to g_set_application_name().
1063 * If you are using #GApplication the program name is set in
1064 * g_application_run(). In case of GDK or GTK+ it is set in
1065 * gdk_init(), which is called by gtk_init() and the
1066 * #GtkApplication::startup handler. The program name is found by
1067 * taking the last component of @argv[0].
1069 * Note that for thread-safety reasons this function can only be called once.
1072 g_set_prgname (const gchar *prgname)
1076 g_prgname = g_strdup (prgname);
1077 G_UNLOCK (g_prgname);
1080 G_LOCK_DEFINE_STATIC (g_application_name);
1081 static gchar *g_application_name = NULL;
1084 * g_get_application_name:
1086 * Gets a human-readable name for the application, as set by
1087 * g_set_application_name(). This name should be localized if
1088 * possible, and is intended for display to the user. Contrast with
1089 * g_get_prgname(), which gets a non-localized name. If
1090 * g_set_application_name() has not been called, returns the result of
1091 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1094 * Returns: human-readable application name. may return %NULL
1099 g_get_application_name (void)
1103 G_LOCK (g_application_name);
1104 retval = g_application_name;
1105 G_UNLOCK (g_application_name);
1108 return g_get_prgname ();
1114 * g_set_application_name:
1115 * @application_name: localized name of the application
1117 * Sets a human-readable name for the application. This name should be
1118 * localized if possible, and is intended for display to the user.
1119 * Contrast with g_set_prgname(), which sets a non-localized name.
1120 * g_set_prgname() will be called automatically by gtk_init(),
1121 * but g_set_application_name() will not.
1123 * Note that for thread safety reasons, this function can only
1126 * The application name will be used in contexts such as error messages,
1127 * or when displaying an application's name in the task list.
1132 g_set_application_name (const gchar *application_name)
1134 gboolean already_set = FALSE;
1136 G_LOCK (g_application_name);
1137 if (g_application_name)
1140 g_application_name = g_strdup (application_name);
1141 G_UNLOCK (g_application_name);
1144 g_warning ("g_set_application_name() called multiple times");
1147 /* Set @global_str to a copy of @new_value if it’s currently unset or has a
1148 * different value. If its current value matches @new_value, do nothing. If
1149 * replaced, we have to leak the old value as client code could still have
1150 * pointers to it. */
1152 set_str_if_different (gchar **global_str,
1154 const gchar *new_value)
1156 if (*global_str == NULL ||
1157 !g_str_equal (new_value, *global_str))
1159 g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value);
1161 /* We have to leak the old value, as user code could be retaining pointers
1163 *global_str = g_strdup (new_value);
1168 set_strv_if_different (gchar ***global_strv,
1170 const gchar * const *new_value)
1172 if (*global_strv == NULL ||
1173 !g_strv_equal (new_value, (const gchar * const *) *global_strv))
1175 gchar *new_value_str = g_strjoinv (":", (gchar **) new_value);
1176 g_debug ("g_set_user_dirs: Setting %s to %s", type, new_value_str);
1177 g_free (new_value_str);
1179 /* We have to leak the old value, as user code could be retaining pointers
1181 *global_strv = g_strdupv ((gchar **) new_value);
1187 * @first_dir_type: Type of the first directory to set
1188 * @...: Value to set the first directory to, followed by additional type/value
1189 * pairs, followed by %NULL
1191 * Set one or more ‘user’ directories to custom values. This is intended to be
1192 * used by test code (particularly with the %G_TEST_OPTION_ISOLATE_DIRS option)
1193 * to override the values returned by the following functions, so that test
1194 * code can be run without touching an installed system and user data:
1196 * - g_get_home_dir() — use type `HOME`, pass a string
1197 * - g_get_user_cache_dir() — use type `XDG_CACHE_HOME`, pass a string
1198 * - g_get_system_config_dirs() — use type `XDG_CONFIG_DIRS`, pass a
1199 * %NULL-terminated string array
1200 * - g_get_user_config_dir() — use type `XDG_CONFIG_HOME`, pass a string
1201 * - g_get_system_data_dirs() — use type `XDG_DATA_DIRS`, pass a
1202 * %NULL-terminated string array
1203 * - g_get_user_data_dir() — use type `XDG_DATA_HOME`, pass a string
1204 * - g_get_user_runtime_dir() — use type `XDG_RUNTIME_DIR`, pass a string
1206 * The list must be terminated with a %NULL type. All of the values must be
1207 * non-%NULL — passing %NULL as a value won’t reset a directory. If a reference
1208 * to a directory from the calling environment needs to be kept, copy it before
1209 * the first call to g_set_user_dirs(). g_set_user_dirs() can be called multiple
1216 g_set_user_dirs (const gchar *first_dir_type,
1220 const gchar *dir_type;
1222 G_LOCK (g_utils_global);
1224 va_start (args, first_dir_type);
1226 for (dir_type = first_dir_type; dir_type != NULL; dir_type = va_arg (args, const gchar *))
1228 gconstpointer dir_value = va_arg (args, gconstpointer);
1229 g_assert (dir_value != NULL);
1231 if (g_str_equal (dir_type, "HOME"))
1232 set_str_if_different (&g_home_dir, dir_type, dir_value);
1233 else if (g_str_equal (dir_type, "XDG_CACHE_HOME"))
1234 set_str_if_different (&g_user_cache_dir, dir_type, dir_value);
1235 else if (g_str_equal (dir_type, "XDG_CONFIG_DIRS"))
1236 set_strv_if_different (&g_system_config_dirs, dir_type, dir_value);
1237 else if (g_str_equal (dir_type, "XDG_CONFIG_HOME"))
1238 set_str_if_different (&g_user_config_dir, dir_type, dir_value);
1239 else if (g_str_equal (dir_type, "XDG_DATA_DIRS"))
1240 set_strv_if_different (&g_system_data_dirs, dir_type, dir_value);
1241 else if (g_str_equal (dir_type, "XDG_DATA_HOME"))
1242 set_str_if_different (&g_user_data_dir, dir_type, dir_value);
1243 else if (g_str_equal (dir_type, "XDG_RUNTIME_DIR"))
1244 set_str_if_different (&g_user_runtime_dir, dir_type, dir_value);
1246 g_assert_not_reached ();
1251 G_UNLOCK (g_utils_global);
1255 g_build_user_data_dir (void)
1257 gchar *data_dir = NULL;
1258 const gchar *data_dir_env = g_getenv ("XDG_DATA_HOME");
1260 if (data_dir_env && data_dir_env[0])
1261 data_dir = g_strdup (data_dir_env);
1264 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1266 if (!data_dir || !data_dir[0])
1268 gchar *home_dir = g_build_home_dir ();
1269 data_dir = g_build_filename (home_dir, ".local", "share", NULL);
1273 return g_steal_pointer (&data_dir);
1277 * g_get_user_data_dir:
1279 * Returns a base directory in which to access application data such
1280 * as icons that is customized for a particular user.
1282 * On UNIX platforms this is determined using the mechanisms described
1284 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1285 * In this case the directory retrieved will be `XDG_DATA_HOME`.
1287 * On Windows it follows XDG Base Directory Specification if `XDG_DATA_HOME`
1288 * is defined. If `XDG_DATA_HOME` is undefined, the folder to use for local (as
1289 * opposed to roaming) application data is used instead. See the
1290 * [documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata).
1291 * Note that in this case on Windows it will be the same
1292 * as what g_get_user_config_dir() returns.
1294 * Returns: (type filename): a string owned by GLib that must not be modified
1299 g_get_user_data_dir (void)
1301 const gchar *user_data_dir;
1303 G_LOCK (g_utils_global);
1305 if (g_user_data_dir == NULL)
1306 g_user_data_dir = g_build_user_data_dir ();
1307 user_data_dir = g_user_data_dir;
1309 G_UNLOCK (g_utils_global);
1311 return user_data_dir;
1315 g_build_user_config_dir (void)
1317 gchar *config_dir = NULL;
1318 const gchar *config_dir_env = g_getenv ("XDG_CONFIG_HOME");
1320 if (config_dir_env && config_dir_env[0])
1321 config_dir = g_strdup (config_dir_env);
1324 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1326 if (!config_dir || !config_dir[0])
1328 gchar *home_dir = g_build_home_dir ();
1329 config_dir = g_build_filename (home_dir, ".config", NULL);
1333 return g_steal_pointer (&config_dir);
1337 * g_get_user_config_dir:
1339 * Returns a base directory in which to store user-specific application
1340 * configuration information such as user preferences and settings.
1342 * On UNIX platforms this is determined using the mechanisms described
1344 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1345 * In this case the directory retrieved will be `XDG_CONFIG_HOME`.
1347 * On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_HOME` is defined.
1348 * If `XDG_CONFIG_HOME` is undefined, the folder to use for local (as opposed
1349 * to roaming) application data is used instead. See the
1350 * [documentation for `CSIDL_LOCAL_APPDATA`](https://msdn.microsoft.com/en-us/library/windows/desktop/bb762494%28v=vs.85%29.aspx#csidl_local_appdata).
1351 * Note that in this case on Windows it will be the same
1352 * as what g_get_user_data_dir() returns.
1354 * Returns: (type filename): a string owned by GLib that must not be modified
1359 g_get_user_config_dir (void)
1361 const gchar *user_config_dir;
1363 G_LOCK (g_utils_global);
1365 if (g_user_config_dir == NULL)
1366 g_user_config_dir = g_build_user_config_dir ();
1367 user_config_dir = g_user_config_dir;
1369 G_UNLOCK (g_utils_global);
1371 return user_config_dir;
1375 g_build_user_cache_dir (void)
1377 gchar *cache_dir = NULL;
1378 const gchar *cache_dir_env = g_getenv ("XDG_CACHE_HOME");
1380 if (cache_dir_env && cache_dir_env[0])
1381 cache_dir = g_strdup (cache_dir_env);
1384 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE);
1386 if (!cache_dir || !cache_dir[0])
1388 gchar *home_dir = g_build_home_dir ();
1389 cache_dir = g_build_filename (home_dir, ".cache", NULL);
1393 return g_steal_pointer (&cache_dir);
1397 * g_get_user_cache_dir:
1399 * Returns a base directory in which to store non-essential, cached
1400 * data specific to particular user.
1402 * On UNIX platforms this is determined using the mechanisms described
1404 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1405 * In this case the directory retrieved will be `XDG_CACHE_HOME`.
1407 * On Windows it follows XDG Base Directory Specification if `XDG_CACHE_HOME` is defined.
1408 * If `XDG_CACHE_HOME` is undefined, the directory that serves as a common
1409 * repository for temporary Internet files is used instead. A typical path is
1410 * `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`.
1411 * 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).
1413 * Returns: (type filename): a string owned by GLib that must not be modified
1418 g_get_user_cache_dir (void)
1420 const gchar *user_cache_dir;
1422 G_LOCK (g_utils_global);
1424 if (g_user_cache_dir == NULL)
1425 g_user_cache_dir = g_build_user_cache_dir ();
1426 user_cache_dir = g_user_cache_dir;
1428 G_UNLOCK (g_utils_global);
1430 return user_cache_dir;
1434 g_build_user_runtime_dir (void)
1436 gchar *runtime_dir = NULL;
1437 const gchar *runtime_dir_env = g_getenv ("XDG_RUNTIME_DIR");
1439 if (runtime_dir_env && runtime_dir_env[0])
1440 runtime_dir = g_strdup (runtime_dir_env);
1443 runtime_dir = g_build_user_cache_dir ();
1445 /* The user should be able to rely on the directory existing
1446 * when the function returns. Probably it already does, but
1447 * let's make sure. Just do mkdir() directly since it will be
1448 * no more expensive than a stat() in the case that the
1449 * directory already exists and is a lot easier.
1451 * $XDG_CACHE_HOME is probably ~/.cache/ so as long as $HOME
1452 * exists this will work. If the user changed $XDG_CACHE_HOME
1453 * then they can make sure that it exists...
1455 (void) g_mkdir (runtime_dir, 0700);
1458 return g_steal_pointer (&runtime_dir);
1462 * g_get_user_runtime_dir:
1464 * Returns a directory that is unique to the current user on the local
1467 * This is determined using the mechanisms described
1469 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1470 * This is the directory
1471 * specified in the `XDG_RUNTIME_DIR` environment variable.
1472 * In the case that this variable is not set, we return the value of
1473 * g_get_user_cache_dir(), after verifying that it exists.
1475 * Returns: (type filename): a string owned by GLib that must not be
1476 * modified or freed.
1481 g_get_user_runtime_dir (void)
1483 const gchar *user_runtime_dir;
1485 G_LOCK (g_utils_global);
1487 if (g_user_runtime_dir == NULL)
1488 g_user_runtime_dir = g_build_user_runtime_dir ();
1489 user_runtime_dir = g_user_runtime_dir;
1491 G_UNLOCK (g_utils_global);
1493 return user_runtime_dir;
1498 /* Implemented in gutils-macos.m */
1499 void load_user_special_dirs_macos (gchar **table);
1502 load_user_special_dirs (void)
1504 load_user_special_dirs_macos (g_user_special_dirs);
1507 #elif defined(G_OS_WIN32)
1510 load_user_special_dirs (void)
1512 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1516 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1518 static const GUID FOLDERID_Downloads =
1519 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1520 static const GUID FOLDERID_Public =
1521 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1525 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1526 "SHGetKnownFolderPath");
1528 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1529 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1531 if (p_SHGetKnownFolderPath == NULL)
1533 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1538 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1541 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1542 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1543 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1544 CoTaskMemFree (wcp);
1547 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1550 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1551 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1553 if (p_SHGetKnownFolderPath == NULL)
1556 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1561 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1564 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1565 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1566 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1567 CoTaskMemFree (wcp);
1570 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1573 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1574 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1577 #else /* default is unix */
1579 /* adapted from xdg-user-dir-lookup.c
1581 * Copyright (C) 2007 Red Hat Inc.
1583 * Permission is hereby granted, free of charge, to any person
1584 * obtaining a copy of this software and associated documentation files
1585 * (the "Software"), to deal in the Software without restriction,
1586 * including without limitation the rights to use, copy, modify, merge,
1587 * publish, distribute, sublicense, and/or sell copies of the Software,
1588 * and to permit persons to whom the Software is furnished to do so,
1589 * subject to the following conditions:
1591 * The above copyright notice and this permission notice shall be
1592 * included in all copies or substantial portions of the Software.
1594 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1595 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1596 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1597 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1598 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1599 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1600 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1604 load_user_special_dirs (void)
1606 gchar *config_dir = NULL;
1612 config_dir = g_build_user_config_dir ();
1613 config_file = g_build_filename (config_dir,
1616 g_free (config_dir);
1618 if (!g_file_get_contents (config_file, &data, NULL, NULL))
1620 g_free (config_file);
1624 lines = g_strsplit (data, "\n", -1);
1625 n_lines = g_strv_length (lines);
1628 for (i = 0; i < n_lines; i++)
1630 gchar *buffer = lines[i];
1633 gboolean is_relative = FALSE;
1634 GUserDirectory directory;
1636 /* Remove newline at end */
1637 len = strlen (buffer);
1638 if (len > 0 && buffer[len - 1] == '\n')
1639 buffer[len - 1] = 0;
1642 while (*p == ' ' || *p == '\t')
1645 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1647 directory = G_USER_DIRECTORY_DESKTOP;
1648 p += strlen ("XDG_DESKTOP_DIR");
1650 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1652 directory = G_USER_DIRECTORY_DOCUMENTS;
1653 p += strlen ("XDG_DOCUMENTS_DIR");
1655 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1657 directory = G_USER_DIRECTORY_DOWNLOAD;
1658 p += strlen ("XDG_DOWNLOAD_DIR");
1660 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1662 directory = G_USER_DIRECTORY_MUSIC;
1663 p += strlen ("XDG_MUSIC_DIR");
1665 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1667 directory = G_USER_DIRECTORY_PICTURES;
1668 p += strlen ("XDG_PICTURES_DIR");
1670 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1672 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1673 p += strlen ("XDG_PUBLICSHARE_DIR");
1675 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1677 directory = G_USER_DIRECTORY_TEMPLATES;
1678 p += strlen ("XDG_TEMPLATES_DIR");
1680 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1682 directory = G_USER_DIRECTORY_VIDEOS;
1683 p += strlen ("XDG_VIDEOS_DIR");
1688 while (*p == ' ' || *p == '\t')
1695 while (*p == ' ' || *p == '\t')
1702 if (strncmp (p, "$HOME", 5) == 0)
1710 d = strrchr (p, '"');
1717 /* remove trailing slashes */
1719 if (d[len - 1] == '/')
1724 gchar *home_dir = g_build_home_dir ();
1725 g_user_special_dirs[directory] = g_build_filename (home_dir, d, NULL);
1729 g_user_special_dirs[directory] = g_strdup (d);
1733 g_free (config_file);
1736 #endif /* platform-specific load_user_special_dirs implementations */
1740 * g_reload_user_special_dirs_cache:
1742 * Resets the cache used for g_get_user_special_dir(), so
1743 * that the latest on-disk version is used. Call this only
1744 * if you just changed the data on disk yourself.
1746 * Due to thread safety issues this may cause leaking of strings
1747 * that were previously returned from g_get_user_special_dir()
1748 * that can't be freed. We ensure to only leak the data for
1749 * the directories that actually changed value though.
1754 g_reload_user_special_dirs_cache (void)
1758 G_LOCK (g_utils_global);
1760 if (g_user_special_dirs != NULL)
1762 /* save a copy of the pointer, to check if some memory can be preserved */
1763 char **old_g_user_special_dirs = g_user_special_dirs;
1766 /* recreate and reload our cache */
1767 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1768 load_user_special_dirs ();
1770 /* only leak changed directories */
1771 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1773 old_val = old_g_user_special_dirs[i];
1774 if (g_user_special_dirs[i] == NULL)
1776 g_user_special_dirs[i] = old_val;
1778 else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1781 g_free (g_user_special_dirs[i]);
1782 g_user_special_dirs[i] = old_val;
1788 /* free the old array */
1789 g_free (old_g_user_special_dirs);
1792 G_UNLOCK (g_utils_global);
1796 * g_get_user_special_dir:
1797 * @directory: the logical id of special directory
1799 * Returns the full path of a special directory using its logical id.
1801 * On UNIX this is done using the XDG special user directories.
1802 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1803 * falls back to `$HOME/Desktop` when XDG special user directories have
1806 * Depending on the platform, the user might be able to change the path
1807 * of the special directory without requiring the session to restart; GLib
1808 * will not reflect any change once the special directories are loaded.
1810 * Returns: (type filename): the path to the specified special directory, or
1811 * %NULL if the logical id was not found. The returned string is owned by
1812 * GLib and should not be modified or freed.
1817 g_get_user_special_dir (GUserDirectory directory)
1819 const gchar *user_special_dir;
1821 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1822 directory < G_USER_N_DIRECTORIES, NULL);
1824 G_LOCK (g_utils_global);
1826 if (G_UNLIKELY (g_user_special_dirs == NULL))
1828 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1830 load_user_special_dirs ();
1832 /* Special-case desktop for historical compatibility */
1833 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1835 gchar *home_dir = g_build_home_dir ();
1836 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (home_dir, "Desktop", NULL);
1840 user_special_dir = g_user_special_dirs[directory];
1842 G_UNLOCK (g_utils_global);
1844 return user_special_dir;
1849 #undef g_get_system_data_dirs
1852 get_module_for_address (gconstpointer address)
1854 /* Holds the g_utils_global lock */
1856 static gboolean beenhere = FALSE;
1857 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1858 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1859 HMODULE hmodule = NULL;
1866 p_GetModuleHandleExA =
1867 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1868 "GetModuleHandleExA");
1872 if (p_GetModuleHandleExA == NULL ||
1873 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1874 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1877 MEMORY_BASIC_INFORMATION mbi;
1878 VirtualQuery (address, &mbi, sizeof (mbi));
1879 hmodule = (HMODULE) mbi.AllocationBase;
1886 get_module_share_dir (gconstpointer address)
1892 hmodule = get_module_for_address (address);
1893 if (hmodule == NULL)
1896 filename = g_win32_get_package_installation_directory_of_module (hmodule);
1897 retval = g_build_filename (filename, "share", NULL);
1903 static const gchar * const *
1904 g_win32_get_system_data_dirs_for_module_real (void (*address_of_function)(void))
1908 static GHashTable *per_module_data_dirs = NULL;
1914 if (address_of_function)
1916 G_LOCK (g_utils_global);
1917 hmodule = get_module_for_address (address_of_function);
1918 if (hmodule != NULL)
1920 if (per_module_data_dirs == NULL)
1921 per_module_data_dirs = g_hash_table_new (NULL, NULL);
1924 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1928 G_UNLOCK (g_utils_global);
1929 return (const gchar * const *) retval;
1935 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1937 /* Documents and Settings\All Users\Application Data */
1938 p = get_special_folder (CSIDL_COMMON_APPDATA);
1940 g_array_append_val (data_dirs, p);
1942 /* Documents and Settings\All Users\Documents */
1943 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1945 g_array_append_val (data_dirs, p);
1947 /* Using the above subfolders of Documents and Settings perhaps
1948 * makes sense from a Windows perspective.
1950 * But looking at the actual use cases of this function in GTK+
1951 * and GNOME software, what we really want is the "share"
1952 * subdirectory of the installation directory for the package
1953 * our caller is a part of.
1955 * The address_of_function parameter, if non-NULL, points to a
1956 * function in the calling module. Use that to determine that
1957 * module's installation folder, and use its "share" subfolder.
1959 * Additionally, also use the "share" subfolder of the installation
1960 * locations of GLib and the .exe file being run.
1962 * To guard against none of the above being what is really wanted,
1963 * callers of this function should have Win32-specific code to look
1964 * up their installation folder themselves, and handle a subfolder
1965 * "share" of it in the same way as the folders returned from this
1969 p = get_module_share_dir (address_of_function);
1971 g_array_append_val (data_dirs, p);
1973 if (glib_dll != NULL)
1975 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1976 p = g_build_filename (glib_root, "share", NULL);
1978 g_array_append_val (data_dirs, p);
1982 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1983 p = g_build_filename (exe_root, "share", NULL);
1985 g_array_append_val (data_dirs, p);
1988 retval = (gchar **) g_array_free (data_dirs, FALSE);
1990 if (address_of_function)
1992 if (hmodule != NULL)
1993 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1994 G_UNLOCK (g_utils_global);
1997 return (const gchar * const *) retval;
2000 const gchar * const *
2001 g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
2003 gboolean should_call_g_get_system_data_dirs;
2005 should_call_g_get_system_data_dirs = TRUE;
2006 /* These checks are the same as the ones that g_build_system_data_dirs() does.
2007 * Please keep them in sync.
2009 G_LOCK (g_utils_global);
2011 if (!g_system_data_dirs)
2013 const gchar *data_dirs = g_getenv ("XDG_DATA_DIRS");
2015 if (!data_dirs || !data_dirs[0])
2016 should_call_g_get_system_data_dirs = FALSE;
2019 G_UNLOCK (g_utils_global);
2021 /* There is a subtle difference between g_win32_get_system_data_dirs_for_module (NULL),
2022 * which is what GLib code can normally call,
2023 * and g_win32_get_system_data_dirs_for_module (&_g_win32_get_system_data_dirs),
2024 * which is what the inline function used by non-GLib code calls.
2025 * The former gets prefix relative to currently-running executable,
2026 * the latter - relative to the module that calls _g_win32_get_system_data_dirs()
2027 * (disguised as g_get_system_data_dirs()), which could be an executable or
2028 * a DLL that is located somewhere else.
2029 * This is why that inline function in gutils.h exists, and why we can't just
2030 * call g_get_system_data_dirs() from there - because we need to get the address
2031 * local to the non-GLib caller-module.
2035 * g_get_system_data_dirs() will fall back to calling
2036 * g_win32_get_system_data_dirs_for_module_real(NULL) if XDG_DATA_DIRS is NULL
2037 * or an empty string. The checks above ensure that we do not call it in such
2038 * cases and use the address_of_function that we've been given by the inline function.
2039 * The reason we're calling g_get_system_data_dirs /at all/ is to give
2040 * XDG_DATA_DIRS precedence (if it is set).
2042 if (should_call_g_get_system_data_dirs)
2043 return g_get_system_data_dirs ();
2045 return g_win32_get_system_data_dirs_for_module_real (address_of_function);
2051 g_build_system_data_dirs (void)
2053 gchar **data_dir_vector = NULL;
2054 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2056 /* These checks are the same as the ones that g_win32_get_system_data_dirs_for_module()
2057 * does. Please keep them in sync.
2060 if (!data_dirs || !data_dirs[0])
2061 data_dirs = "/usr/local/share/:/usr/share/";
2063 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2065 if (!data_dirs || !data_dirs[0])
2066 data_dir_vector = g_strdupv ((gchar **) g_win32_get_system_data_dirs_for_module_real (NULL));
2068 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2071 return g_steal_pointer (&data_dir_vector);
2075 * g_get_system_data_dirs:
2077 * Returns an ordered list of base directories in which to access
2078 * system-wide application data.
2080 * On UNIX platforms this is determined using the mechanisms described
2082 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec)
2083 * In this case the list of directories retrieved will be `XDG_DATA_DIRS`.
2085 * On Windows it follows XDG Base Directory Specification if `XDG_DATA_DIRS` is defined.
2086 * If `XDG_DATA_DIRS` is undefined,
2087 * the first elements in the list are the Application Data
2088 * and Documents folders for All Users. (These can be determined only
2089 * on Windows 2000 or later and are not present in the list on other
2090 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
2091 * CSIDL_COMMON_DOCUMENTS.
2093 * Then follows the "share" subfolder in the installation folder for
2094 * the package containing the DLL that calls this function, if it can
2097 * Finally the list contains the "share" subfolder in the installation
2098 * folder for GLib, and in the installation folder for the package the
2099 * application's .exe file belongs to.
2101 * The installation folders above are determined by looking up the
2102 * folder where the module (DLL or EXE) in question is located. If the
2103 * folder's name is "bin", its parent is used, otherwise the folder
2106 * Note that on Windows the returned list can vary depending on where
2107 * this function is called.
2109 * Returns: (array zero-terminated=1) (element-type filename) (transfer none):
2110 * a %NULL-terminated array of strings owned by GLib that must not be
2111 * modified or freed.
2115 const gchar * const *
2116 g_get_system_data_dirs (void)
2118 const gchar * const *system_data_dirs;
2120 G_LOCK (g_utils_global);
2122 if (g_system_data_dirs == NULL)
2123 g_system_data_dirs = g_build_system_data_dirs ();
2124 system_data_dirs = (const gchar * const *) g_system_data_dirs;
2126 G_UNLOCK (g_utils_global);
2128 return system_data_dirs;
2132 g_build_system_config_dirs (void)
2134 gchar **conf_dir_vector = NULL;
2135 const gchar *conf_dirs = g_getenv ("XDG_CONFIG_DIRS");
2139 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2143 gchar *special_conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2145 if (special_conf_dirs)
2146 conf_dir_vector = g_strsplit (special_conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2148 /* Return empty list */
2149 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2151 g_free (special_conf_dirs);
2154 if (!conf_dirs || !conf_dirs[0])
2155 conf_dirs = "/etc/xdg";
2157 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2160 return g_steal_pointer (&conf_dir_vector);
2164 * g_get_system_config_dirs:
2166 * Returns an ordered list of base directories in which to access
2167 * system-wide configuration information.
2169 * On UNIX platforms this is determined using the mechanisms described
2171 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
2172 * In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.
2174 * On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_DIRS` is defined.
2175 * If `XDG_CONFIG_DIRS` is undefined, the directory that contains application
2176 * data for all users is used instead. A typical path is
2177 * `C:\Documents and Settings\All Users\Application Data`.
2178 * This folder is used for application data
2179 * that is not user specific. For example, an application can store
2180 * a spell-check dictionary, a database of clip art, or a log file in the
2181 * CSIDL_COMMON_APPDATA folder. This information will not roam and is available
2182 * to anyone using the computer.
2184 * Returns: (array zero-terminated=1) (element-type filename) (transfer none):
2185 * a %NULL-terminated array of strings owned by GLib that must not be
2186 * modified or freed.
2190 const gchar * const *
2191 g_get_system_config_dirs (void)
2193 const gchar * const *system_config_dirs;
2195 G_LOCK (g_utils_global);
2197 if (g_system_config_dirs == NULL)
2198 g_system_config_dirs = g_build_system_config_dirs ();
2199 system_config_dirs = (const gchar * const *) g_system_config_dirs;
2201 G_UNLOCK (g_utils_global);
2203 return system_config_dirs;
2207 * g_nullify_pointer:
2208 * @nullify_location: (not nullable): the memory address of the pointer.
2210 * Set the pointer at the specified location to %NULL.
2213 g_nullify_pointer (gpointer *nullify_location)
2215 g_return_if_fail (nullify_location != NULL);
2217 *nullify_location = NULL;
2220 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2221 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2222 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2223 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2224 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2225 #define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2227 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2228 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2229 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2230 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2231 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2232 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2236 * @size: a size in bytes
2238 * Formats a size (for example the size of a file) into a human readable
2239 * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
2240 * and are displayed rounded to the nearest tenth. E.g. the file size
2241 * 3292528 bytes will be converted into the string "3.2 MB". The returned string
2242 * is UTF-8, and may use a non-breaking space to separate the number and units,
2243 * to ensure they aren’t separated when line wrapped.
2245 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2247 * This string should be freed with g_free() when not needed any longer.
2249 * See g_format_size_full() for more options about how the size might be
2252 * Returns: a newly-allocated formatted string containing a human readable
2258 g_format_size (guint64 size)
2260 return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2265 * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2266 * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2267 * of the returned string. For example, "45.6 kB (45,612 bytes)".
2268 * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2269 * suffixes. IEC units should only be used for reporting things with
2270 * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2271 * Network and storage sizes should be reported in the normal SI units.
2272 * @G_FORMAT_SIZE_BITS: set the size as a quantity in bits, rather than
2273 * bytes, and return units in bits. For example, ‘Mb’ rather than ‘MB’.
2275 * Flags to modify the format of the string returned by g_format_size_full().
2278 #pragma GCC diagnostic push
2279 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
2282 * g_format_size_full:
2283 * @size: a size in bytes
2284 * @flags: #GFormatSizeFlags to modify the output
2288 * This function is similar to g_format_size() but allows for flags
2289 * that modify the output. See #GFormatSizeFlags.
2291 * Returns: a newly-allocated formatted string containing a human
2292 * readable file size
2297 g_format_size_full (guint64 size,
2298 GFormatSizeFlags flags)
2314 const struct Format formats[4][6] = {
2316 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2317 { KILOBYTE_FACTOR, N_("%.1f kB") },
2318 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2319 { MEGABYTE_FACTOR, N_("%.1f MB") },
2320 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2321 { GIGABYTE_FACTOR, N_("%.1f GB") },
2322 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2323 { TERABYTE_FACTOR, N_("%.1f TB") },
2324 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2325 { PETABYTE_FACTOR, N_("%.1f PB") },
2326 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2327 { EXABYTE_FACTOR, N_("%.1f EB") }
2330 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2331 { KIBIBYTE_FACTOR, N_("%.1f KiB") },
2332 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2333 { MEBIBYTE_FACTOR, N_("%.1f MiB") },
2334 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2335 { GIBIBYTE_FACTOR, N_("%.1f GiB") },
2336 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2337 { TEBIBYTE_FACTOR, N_("%.1f TiB") },
2338 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2339 { PEBIBYTE_FACTOR, N_("%.1f PiB") },
2340 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2341 { EXBIBYTE_FACTOR, N_("%.1f EiB") }
2344 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2345 { KILOBYTE_FACTOR, N_("%.1f kb") },
2346 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2347 { MEGABYTE_FACTOR, N_("%.1f Mb") },
2348 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2349 { GIGABYTE_FACTOR, N_("%.1f Gb") },
2350 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2351 { TERABYTE_FACTOR, N_("%.1f Tb") },
2352 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2353 { PETABYTE_FACTOR, N_("%.1f Pb") },
2354 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2355 { EXABYTE_FACTOR, N_("%.1f Eb") }
2358 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2359 { KIBIBYTE_FACTOR, N_("%.1f Kib") },
2360 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2361 { MEBIBYTE_FACTOR, N_("%.1f Mib") },
2362 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2363 { GIBIBYTE_FACTOR, N_("%.1f Gib") },
2364 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2365 { TEBIBYTE_FACTOR, N_("%.1f Tib") },
2366 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2367 { PEBIBYTE_FACTOR, N_("%.1f Pib") },
2368 /* Translators: Keep the no-break space between %.1f and the unit symbol */
2369 { EXBIBYTE_FACTOR, N_("%.1f Eib") }
2376 string = g_string_new (NULL);
2378 switch (flags & ~G_FORMAT_SIZE_LONG_FORMAT)
2380 case G_FORMAT_SIZE_DEFAULT:
2381 index = FORMAT_BYTES;
2383 case (G_FORMAT_SIZE_DEFAULT | G_FORMAT_SIZE_IEC_UNITS):
2384 index = FORMAT_BYTES_IEC;
2386 case G_FORMAT_SIZE_BITS:
2387 index = FORMAT_BITS;
2389 case (G_FORMAT_SIZE_BITS | G_FORMAT_SIZE_IEC_UNITS):
2390 index = FORMAT_BITS_IEC;
2393 g_assert_not_reached ();
2397 if (size < formats[index][0].factor)
2399 const char * format;
2401 if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
2403 format = g_dngettext (GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size);
2407 format = g_dngettext (GETTEXT_PACKAGE, "%u bit", "%u bits", (guint) size);
2410 g_string_printf (string, format, (guint) size);
2412 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2416 const gsize n = G_N_ELEMENTS (formats[index]);
2420 * Point the last format (the highest unit) by default
2421 * and then then scan all formats, starting with the 2nd one
2422 * because the 1st is already managed by with the plural form
2424 const struct Format * f = &formats[index][n - 1];
2426 for (i = 1; i < n; i++)
2428 if (size < formats[index][i].factor)
2430 f = &formats[index][i - 1];
2435 g_string_printf (string, _(f->string), (gdouble) size / (gdouble) f->factor);
2438 if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2440 /* First problem: we need to use the number of bytes to decide on
2441 * the plural form that is used for display, but the number of
2442 * bytes potentially exceeds the size of a guint (which is what
2443 * ngettext() takes).
2445 * From a pragmatic standpoint, it seems that all known languages
2446 * base plural forms on one or both of the following:
2448 * - the lowest digits of the number
2450 * - if the number if greater than some small value
2452 * Here's how we fake it: Draw an arbitrary line at one thousand.
2453 * If the number is below that, then fine. If it is above it,
2454 * then we take the modulus of the number by one thousand (in
2455 * order to keep the lowest digits) and add one thousand to that
2456 * (in order to ensure that 1001 is not treated the same as 1).
2458 guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2460 /* Second problem: we need to translate the string "%u byte/bit" and
2461 * "%u bytes/bits" for pluralisation, but the correct number format to
2462 * use for a gsize is different depending on which architecture
2465 * Solution: format the number separately and use "%s bytes/bits" on
2468 const gchar *translated_format;
2469 gchar *formatted_number;
2471 if (index == FORMAT_BYTES || index == FORMAT_BYTES_IEC)
2473 /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2474 translated_format = g_dngettext (GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2478 /* Translators: the %s in "%s bits" will always be replaced by a number. */
2479 translated_format = g_dngettext (GETTEXT_PACKAGE, "%s bit", "%s bits", plural_form);
2481 formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2483 g_string_append (string, " (");
2484 g_string_append_printf (string, translated_format, formatted_number);
2485 g_free (formatted_number);
2486 g_string_append (string, ")");
2489 return g_string_free (string, FALSE);
2492 #pragma GCC diagnostic pop
2495 * g_format_size_for_display:
2496 * @size: a size in bytes
2498 * Formats a size (for example the size of a file) into a human
2499 * readable string. Sizes are rounded to the nearest size prefix
2500 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2501 * E.g. the file size 3292528 bytes will be converted into the
2504 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2506 * This string should be freed with g_free() when not needed any longer.
2508 * Returns: a newly-allocated formatted string containing a human
2509 * readable file size
2513 * Deprecated:2.30: This function is broken due to its use of SI
2514 * suffixes to denote IEC units. Use g_format_size() instead.
2517 g_format_size_for_display (goffset size)
2519 if (size < (goffset) KIBIBYTE_FACTOR)
2520 return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2523 gdouble displayed_size;
2525 if (size < (goffset) MEBIBYTE_FACTOR)
2527 displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2528 /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
2529 * mean 1024 bytes. I am aware that 'KB' is not correct, but it has been preserved for reasons of
2530 * compatibility. Users will not see this string unless a program is using this deprecated function.
2531 * Please translate as literally as possible.
2533 return g_strdup_printf (_("%.1f KB"), displayed_size);
2535 else if (size < (goffset) GIBIBYTE_FACTOR)
2537 displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2538 return g_strdup_printf (_("%.1f MB"), displayed_size);
2540 else if (size < (goffset) TEBIBYTE_FACTOR)
2542 displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2543 return g_strdup_printf (_("%.1f GB"), displayed_size);
2545 else if (size < (goffset) PEBIBYTE_FACTOR)
2547 displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2548 return g_strdup_printf (_("%.1f TB"), displayed_size);
2550 else if (size < (goffset) EXBIBYTE_FACTOR)
2552 displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2553 return g_strdup_printf (_("%.1f PB"), displayed_size);
2557 displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2558 return g_strdup_printf (_("%.1f EB"), displayed_size);
2563 #if defined (G_OS_WIN32) && !defined (_WIN64)
2565 /* Binary compatibility versions. Not for newly compiled code. */
2567 _GLIB_EXTERN const gchar *g_get_user_name_utf8 (void);
2568 _GLIB_EXTERN const gchar *g_get_real_name_utf8 (void);
2569 _GLIB_EXTERN const gchar *g_get_home_dir_utf8 (void);
2570 _GLIB_EXTERN const gchar *g_get_tmp_dir_utf8 (void);
2571 _GLIB_EXTERN gchar *g_find_program_in_path_utf8 (const gchar *program);
2574 g_find_program_in_path_utf8 (const gchar *program)
2576 return g_find_program_in_path (program);
2579 const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
2580 const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
2581 const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
2582 const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
2588 * Returns %TRUE if the current process was executed as setuid
2591 g_check_setuid (void)
2593 #if defined(HAVE_SYS_AUXV_H) && defined(HAVE_GETAUXVAL) && defined(AT_SECURE)
2594 unsigned long value;
2598 value = getauxval (AT_SECURE);
2601 g_error ("getauxval () failed: %s", g_strerror (errsv));
2603 #elif defined(HAVE_ISSETUGID) && !defined(__BIONIC__)
2604 /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
2606 /* Android had it in older versions but the new 64 bit ABI does not
2607 * have it anymore, and some versions of the 32 bit ABI neither.
2608 * https://code.google.com/p/android-developer-preview/issues/detail?id=168
2610 return issetugid ();
2611 #elif defined(G_OS_UNIX)
2612 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
2613 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
2615 static gsize check_setuid_initialised;
2616 static gboolean is_setuid;
2618 if (g_once_init_enter (&check_setuid_initialised))
2620 #ifdef HAVE_GETRESUID
2621 /* These aren't in the header files, so we prototype them here.
2623 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
2624 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
2626 if (getresuid (&ruid, &euid, &suid) != 0 ||
2627 getresgid (&rgid, &egid, &sgid) != 0)
2628 #endif /* HAVE_GETRESUID */
2630 suid = ruid = getuid ();
2631 sgid = rgid = getgid ();
2636 is_setuid = (ruid != euid || ruid != suid ||
2637 rgid != egid || rgid != sgid);
2639 g_once_init_leave (&check_setuid_initialised, 1);
2651 * A wrapper for the POSIX abort() function.
2653 * On Windows it is a function that makes extra effort (including a call
2654 * to abort()) to ensure that a debugger-catchable exception is thrown
2655 * before the program terminates.
2657 * See your C library manual for more details about abort().
2664 /* One call to break the debugger */
2666 /* One call in case CRT does get saner about abort() behaviour */
2668 /* And one call to bind them all and terminate the program for sure */