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 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.
30 #include "glibconfig.h"
37 #include <ctype.h> /* For tolower() */
39 #include <sys/types.h>
45 #include <sys/types.h>
46 #ifdef HAVE_SYS_PARAM_H
47 #include <sys/param.h>
49 #ifdef HAVE_CRT_EXTERNS_H
50 #include <crt_externs.h> /* for _NSGetEnviron */
53 /* implement gutils's inline functions
55 #define G_IMPLEMENT_INLINES 1
59 #include "glib-init.h"
60 #include "glib-private.h"
62 #include "gfileutils.h"
66 #include "gtestutils.h"
68 #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 <CoreServices/CoreServices.h>
128 #include <langinfo.h>
131 #ifdef G_PLATFORM_WIN32
134 _glib_get_dll_directory (void)
138 wchar_t wc_fn[MAX_PATH];
141 if (glib_dll == NULL)
145 /* This code is different from that in
146 * g_win32_get_package_installation_directory_of_module() in that
147 * here we return the actual folder where the GLib DLL is. We don't
148 * do the check for it being in a "bin" or "lib" subfolder and then
149 * returning the parent of that.
151 * In a statically built GLib, glib_dll will be NULL and we will
152 * thus look up the application's .exe file's location.
154 if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
157 retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
159 p = strrchr (retval, G_DIR_SEPARATOR);
174 * @dest: the destination address to copy the bytes to.
175 * @src: the source address to copy the bytes from.
176 * @len: the number of bytes to copy.
178 * Copies a block of memory @len bytes long, from @src to @dest.
179 * The source and destination areas may overlap.
181 * Deprecated:2.40: Just use memmove().
190 * @func: (scope async): the function to call on normal program termination.
192 * Specifies a function to be called at normal program termination.
194 * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
195 * macro that maps to a call to the atexit() function in the C
196 * library. This means that in case the code that calls g_atexit(),
197 * i.e. atexit(), is in a DLL, the function will be called when the
198 * DLL is detached from the program. This typically makes more sense
199 * than that the function is called when the GLib DLL is detached,
200 * which happened earlier when g_atexit() was a function in the GLib
203 * The behaviour of atexit() in the context of dynamically loaded
204 * modules is not formally specified and varies wildly.
206 * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
207 * loaded module which is unloaded before the program terminates might
208 * well cause a crash at program exit.
210 * Some POSIX systems implement atexit() like Windows, and have each
211 * dynamically loaded module maintain an own atexit chain that is
212 * called when the module is unloaded.
214 * On other POSIX systems, before a dynamically loaded module is
215 * unloaded, the registered atexit functions (if any) residing in that
216 * module are called, regardless where the code that registered them
217 * resided. This is presumably the most robust approach.
219 * As can be seen from the above, for portability it's best to avoid
220 * calling g_atexit() (or atexit()) except in the main executable of a
223 * Deprecated:2.32: It is best to avoid g_atexit().
226 g_atexit (GVoidFunc func)
230 result = atexit ((void (*)(void)) func);
233 g_error ("Could not register atexit() function: %s",
238 /* Based on execvp() from GNU Libc.
239 * Some of this code is cut-and-pasted into gspawn.c
243 my_strchrnul (const gchar *str,
246 gchar *p = (gchar*)str;
247 while (*p && (*p != c))
255 static gchar *inner_find_program_in_path (const gchar *program);
258 g_find_program_in_path (const gchar *program)
260 const gchar *last_dot = strrchr (program, '.');
262 if (last_dot == NULL ||
263 strchr (last_dot, '\\') != NULL ||
264 strchr (last_dot, '/') != NULL)
266 const gint program_length = strlen (program);
267 gchar *pathext = g_build_path (";",
268 ".exe;.cmd;.bat;.com",
269 g_getenv ("PATHEXT"),
272 gchar *decorated_program;
278 gchar *q = my_strchrnul (p, ';');
280 decorated_program = g_malloc (program_length + (q-p) + 1);
281 memcpy (decorated_program, program, program_length);
282 memcpy (decorated_program+program_length, p, q-p);
283 decorated_program [program_length + (q-p)] = '\0';
285 retval = inner_find_program_in_path (decorated_program);
286 g_free (decorated_program);
294 } while (*p++ != '\0');
299 return inner_find_program_in_path (program);
305 * g_find_program_in_path:
306 * @program: a program name in the GLib file name encoding
308 * Locates the first executable named @program in the user's path, in the
309 * same way that execvp() would locate it. Returns an allocated string
310 * with the absolute path name, or %NULL if the program is not found in
311 * the path. If @program is already an absolute path, returns a copy of
312 * @program if @program exists and is executable, and %NULL otherwise.
314 * On Windows, if @program does not have a file type suffix, tries
315 * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
316 * the `PATHEXT` environment variable.
318 * On Windows, it looks for the file in the same way as CreateProcess()
319 * would. This means first in the directory where the executing
320 * program was loaded from, then in the current directory, then in the
321 * Windows 32-bit system directory, then in the Windows directory, and
322 * finally in the directories in the `PATH` environment variable. If
323 * the program is found, the return value contains the full name
324 * including the type suffix.
326 * Returns: a newly-allocated string with the absolute path, or %NULL
330 inner_find_program_in_path (const gchar *program)
333 g_find_program_in_path (const gchar *program)
336 const gchar *path, *p;
337 gchar *name, *freeme;
339 const gchar *path_copy;
340 gchar *filename = NULL, *appdir = NULL;
341 gchar *sysdir = NULL, *windir = NULL;
343 wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
349 g_return_val_if_fail (program != NULL, NULL);
351 /* If it is an absolute path, or a relative path including subdirectories,
352 * don't look in PATH.
354 if (g_path_is_absolute (program)
355 || strchr (program, G_DIR_SEPARATOR) != NULL
357 || strchr (program, '/') != NULL
361 if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
362 !g_file_test (program, G_FILE_TEST_IS_DIR))
363 return g_strdup (program);
368 path = g_getenv ("PATH");
369 #if defined(G_OS_UNIX)
372 /* There is no 'PATH' in the environment. The default
373 * search path in GNU libc is the current directory followed by
374 * the path 'confstr' returns for '_CS_PATH'.
377 /* In GLib we put . last, for security, and don't use the
378 * unportable confstr(); UNIX98 does not actually specify
379 * what to search if PATH is unset. POSIX may, dunno.
382 path = "/bin:/usr/bin:.";
385 n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
386 if (n > 0 && n < MAXPATHLEN)
387 filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
389 n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
390 if (n > 0 && n < MAXPATHLEN)
391 sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
393 n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
394 if (n > 0 && n < MAXPATHLEN)
395 windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
399 appdir = g_path_get_dirname (filename);
403 path = g_strdup (path);
407 const gchar *tem = path;
408 path = g_strconcat (windir, ";", path, NULL);
409 g_free ((gchar *) tem);
415 const gchar *tem = path;
416 path = g_strconcat (sysdir, ";", path, NULL);
417 g_free ((gchar *) tem);
422 const gchar *tem = path;
423 path = g_strconcat (".;", path, NULL);
424 g_free ((gchar *) tem);
429 const gchar *tem = path;
430 path = g_strconcat (appdir, ";", path, NULL);
431 g_free ((gchar *) tem);
438 len = strlen (program) + 1;
439 pathlen = strlen (path);
440 freeme = name = g_malloc (pathlen + len + 1);
442 /* Copy the file name at the top, including '\0' */
443 memcpy (name + pathlen + 1, program, len);
444 name = name + pathlen;
445 /* And add the slash before the filename */
446 *name = G_DIR_SEPARATOR;
454 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
457 /* Two adjacent colons, or a colon at the beginning or the end
458 * of 'PATH' means to search the current directory.
462 startp = memcpy (name - (p - path), path, p - path);
464 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
465 !g_file_test (startp, G_FILE_TEST_IS_DIR))
468 ret = g_strdup (startp);
471 g_free ((gchar *) path_copy);
476 while (*p++ != '\0');
480 g_free ((gchar *) path_copy);
488 * @mask: a #gulong containing flags
489 * @nth_bit: the index of the bit to start the search from
491 * Find the position of the first bit set in @mask, searching
492 * from (but not including) @nth_bit upwards. Bits are numbered
493 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
494 * usually). To start searching from the 0th bit, set @nth_bit to -1.
496 * Returns: the index of the first bit set which is higher than @nth_bit
501 * @mask: a #gulong containing flags
502 * @nth_bit: the index of the bit to start the search from
504 * Find the position of the first bit set in @mask, searching
505 * from (but not including) @nth_bit downwards. Bits are numbered
506 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
507 * usually). To start searching from the last bit, set @nth_bit to
508 * -1 or GLIB_SIZEOF_LONG * 8.
510 * Returns: the index of the first bit set which is lower than @nth_bit
517 * Gets the number of bits used to hold @number,
518 * e.g. if @number is 4, 3 bits are needed.
520 * Returns: the number of bits used to hold @number
523 G_LOCK_DEFINE_STATIC (g_utils_global);
532 static gchar *g_user_data_dir = NULL;
533 static gchar **g_system_data_dirs = NULL;
534 static gchar *g_user_cache_dir = NULL;
535 static gchar *g_user_config_dir = NULL;
536 static gchar **g_system_config_dirs = NULL;
538 static gchar **g_user_special_dirs = NULL;
540 /* fifteen minutes of fame for everybody */
541 #define G_USER_DIRS_EXPIRE 15 * 60
546 get_special_folder (int csidl)
548 wchar_t path[MAX_PATH+1];
550 LPITEMIDLIST pidl = NULL;
552 gchar *retval = NULL;
554 hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
557 b = SHGetPathFromIDListW (pidl, path);
559 retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
560 CoTaskMemFree (pidl);
566 get_windows_directory_root (void)
568 wchar_t wwindowsdir[MAX_PATH];
570 if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
572 /* Usually X:\Windows, but in terminal server environments
573 * might be an UNC path, AFAIK.
575 char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
578 if (windowsdir == NULL)
579 return g_strdup ("C:\\");
581 p = (char *) g_path_skip_root (windowsdir);
582 if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
588 return g_strdup ("C:\\");
593 /* HOLDS: g_utils_global_lock */
594 static UserDatabaseEntry *
595 g_get_user_database_entry (void)
597 static UserDatabaseEntry *entry;
599 if (g_once_init_enter (&entry))
601 static UserDatabaseEntry e;
605 struct passwd *pw = NULL;
606 gpointer buffer = NULL;
610 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
612 # ifdef _SC_GETPW_R_SIZE_MAX
613 /* This reurns the maximum length */
614 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
618 # else /* _SC_GETPW_R_SIZE_MAX */
620 # endif /* _SC_GETPW_R_SIZE_MAX */
622 logname = (gchar *) g_getenv ("LOGNAME");
627 /* we allocate 6 extra bytes to work around a bug in
628 * Mac OS < 10.3. See #156446
630 buffer = g_malloc (bufsize + 6);
633 # ifdef HAVE_POSIX_GETPWUID_R
635 error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
636 if (!pw || (pw->pw_uid != getuid ())) {
637 /* LOGNAME is lying, fall back to looking up the uid */
638 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
641 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
643 error = error < 0 ? errno : error;
644 # else /* HAVE_NONPOSIX_GETPWUID_R */
646 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
647 pw = error == 0 ? &pwd : NULL;
650 pw = getpwnam_r (logname, &pwd, buffer, bufsize);
651 if (!pw || (pw->pw_uid != getuid ())) {
652 /* LOGNAME is lying, fall back to looking up the uid */
653 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
656 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
658 error = pw ? 0 : errno;
660 # endif /* HAVE_NONPOSIX_GETPWUID_R */
664 /* we bail out prematurely if the user id can't be found
665 * (should be pretty rare case actually), or if the buffer
666 * should be sufficiently big and lookups are still not
669 if (error == 0 || error == ENOENT)
671 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
675 if (bufsize > 32 * 1024)
677 g_warning ("getpwuid_r(): failed due to: %s.",
686 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
690 pw = getpwuid (getuid ());
694 e.user_name = g_strdup (pw->pw_name);
697 if (pw->pw_gecos && *pw->pw_gecos != '\0')
699 gchar **gecos_fields;
702 /* split the gecos field and substitute '&' */
703 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
704 name_parts = g_strsplit (gecos_fields[0], "&", 0);
705 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
706 e.real_name = g_strjoinv (pw->pw_name, name_parts);
707 g_strfreev (gecos_fields);
708 g_strfreev (name_parts);
713 e.home_dir = g_strdup (pw->pw_dir);
718 #endif /* G_OS_UNIX */
723 wchar_t buffer[UNLEN+1];
725 if (GetUserNameW (buffer, (LPDWORD) &len))
727 e.user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
728 e.real_name = g_strdup (e.user_name);
731 #endif /* G_OS_WIN32 */
734 e.user_name = g_strdup ("somebody");
736 e.real_name = g_strdup ("Unknown");
738 g_once_init_leave (&entry, &e);
747 * Gets the user name of the current user. The encoding of the returned
748 * string is system-defined. On UNIX, it might be the preferred file name
749 * encoding, or something else, and there is no guarantee that it is even
750 * consistent on a machine. On Windows, it is always UTF-8.
752 * Returns: the user name of the current user.
755 g_get_user_name (void)
757 UserDatabaseEntry *entry;
759 entry = g_get_user_database_entry ();
761 return entry->user_name;
767 * Gets the real name of the user. This usually comes from the user's
768 * entry in the `passwd` file. The encoding of the returned string is
769 * system-defined. (On Windows, it is, however, always UTF-8.) If the
770 * real user name cannot be determined, the string "Unknown" is
773 * Returns: the user's real name.
776 g_get_real_name (void)
778 UserDatabaseEntry *entry;
780 entry = g_get_user_database_entry ();
782 return entry->real_name;
788 * Gets the current user's home directory.
790 * As with most UNIX tools, this function will return the value of the
791 * `HOME` environment variable if it is set to an existing absolute path
792 * name, falling back to the `passwd` file in the case that it is unset.
794 * If the path given in `HOME` is non-absolute, does not exist, or is
795 * not a directory, the result is undefined.
797 * Before version 2.36 this function would ignore the `HOME` environment
798 * variable, taking the value from the `passwd` database instead. This was
799 * changed to increase the compatibility of GLib with other programs (and
800 * the XDG basedir specification) and to increase testability of programs
801 * based on GLib (by making it easier to run them from test frameworks).
803 * If your program has a strong requirement for either the new or the
804 * old behaviour (and if you don't wish to increase your GLib
805 * dependency to ensure that the new behaviour is in effect) then you
806 * should either directly check the `HOME` environment variable yourself
807 * or unset it before calling any functions in GLib.
809 * Returns: the current user's home directory
812 g_get_home_dir (void)
814 static gchar *home_dir;
816 if (g_once_init_enter (&home_dir))
820 /* We first check HOME and use it if it is set */
821 tmp = g_strdup (g_getenv ("HOME"));
824 /* Only believe HOME if it is an absolute path and exists.
826 * We only do this check on Windows for a couple of reasons.
827 * Historically, we only did it there because we used to ignore $HOME
828 * on UNIX. There are concerns about enabling it now on UNIX because
829 * of things like autofs. In short, if the user has a bogus value in
830 * $HOME then they get what they pay for...
834 if (!(g_path_is_absolute (tmp) &&
835 g_file_test (tmp, G_FILE_TEST_IS_DIR)))
842 /* In case HOME is Unix-style (it happens), convert it to
848 while ((p = strchr (tmp, '/')) != NULL)
854 /* USERPROFILE is probably the closest equivalent to $HOME? */
855 if (g_getenv ("USERPROFILE") != NULL)
856 tmp = g_strdup (g_getenv ("USERPROFILE"));
860 tmp = get_special_folder (CSIDL_PROFILE);
863 tmp = get_windows_directory_root ();
864 #endif /* G_OS_WIN32 */
868 /* If we didn't get it from any of those methods, we will have
869 * to read the user database entry.
871 UserDatabaseEntry *entry;
873 entry = g_get_user_database_entry ();
875 /* Strictly speaking, we should copy this, but we know that
876 * neither will ever be freed, so don't bother...
878 tmp = entry->home_dir;
881 g_once_init_leave (&home_dir, tmp);
890 * Gets the directory to use for temporary files.
892 * On UNIX, this is taken from the `TMPDIR` environment variable.
893 * If the variable is not set, `P_tmpdir` is
894 * used, as defined by the system C library. Failing that, a
895 * hard-coded default of "/tmp" is returned.
897 * On Windows, the `TEMP` environment variable is used, with the
898 * root directory of the Windows installation (eg: "C:\") used
901 * The encoding of the returned string is system-defined. On Windows,
902 * it is always UTF-8. The return value is never %NULL or the empty
905 * Returns: the directory to use for temporary files.
910 static gchar *tmp_dir;
912 if (g_once_init_enter (&tmp_dir))
917 tmp = g_strdup (g_getenv ("TEMP"));
919 if (tmp == NULL || *tmp == '\0')
922 tmp = get_windows_directory_root ();
924 #else /* G_OS_WIN32 */
925 tmp = g_strdup (g_getenv ("TMPDIR"));
928 if (tmp == NULL || *tmp == '\0')
932 tmp = g_strdup (P_tmpdir);
934 if (k > 1 && G_IS_DIR_SEPARATOR (tmp[k - 1]))
937 #endif /* P_tmpdir */
939 if (tmp == NULL || *tmp == '\0')
942 tmp = g_strdup ("/tmp");
944 #endif /* !G_OS_WIN32 */
946 g_once_init_leave (&tmp_dir, tmp);
955 * Return a name for the machine.
957 * The returned name is not necessarily a fully-qualified domain name,
958 * or even present in DNS or some other name service at all. It need
959 * not even be unique on your local network or site, but usually it
960 * is. Callers should not rely on the return value having any specific
961 * properties like uniqueness for security purposes. Even if the name
962 * of the machine is changed while an application is running, the
963 * return value from this function does not change. The returned
964 * string is owned by GLib and should not be modified or freed. If no
965 * name can be determined, a default fixed string "localhost" is
968 * Returns: the host name of the machine.
973 g_get_host_name (void)
975 static gchar *hostname;
977 if (g_once_init_enter (&hostname))
983 failed = (gethostname (tmp, sizeof (tmp)) == -1);
985 DWORD size = sizeof (tmp);
986 failed = (!GetComputerName (tmp, &size));
989 g_once_init_leave (&hostname, g_strdup (failed ? "localhost" : tmp));
995 G_LOCK_DEFINE_STATIC (g_prgname);
996 static gchar *g_prgname = NULL;
1001 * Gets the name of the program. This name should not be localized,
1002 * in contrast to g_get_application_name().
1004 * If you are using GDK or GTK+ the program name is set in gdk_init(),
1005 * which is called by gtk_init(). The program name is found by taking
1006 * the last component of @argv[0].
1008 * Returns: the name of the program. The returned string belongs
1009 * to GLib and must not be modified or freed.
1012 g_get_prgname (void)
1018 if (g_prgname == NULL)
1020 static gboolean beenhere = FALSE;
1024 gchar *utf8_buf = NULL;
1025 wchar_t buf[MAX_PATH+1];
1028 if (GetModuleFileNameW (GetModuleHandle (NULL),
1029 buf, G_N_ELEMENTS (buf)) > 0)
1030 utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1034 g_prgname = g_path_get_basename (utf8_buf);
1041 G_UNLOCK (g_prgname);
1048 * @prgname: the name of the program.
1050 * Sets the name of the program. This name should not be localized,
1051 * in contrast to g_set_application_name().
1053 * Note that for thread-safety reasons this function can only be called once.
1056 g_set_prgname (const gchar *prgname)
1060 g_prgname = g_strdup (prgname);
1061 G_UNLOCK (g_prgname);
1064 G_LOCK_DEFINE_STATIC (g_application_name);
1065 static gchar *g_application_name = NULL;
1068 * g_get_application_name:
1070 * Gets a human-readable name for the application, as set by
1071 * g_set_application_name(). This name should be localized if
1072 * possible, and is intended for display to the user. Contrast with
1073 * g_get_prgname(), which gets a non-localized name. If
1074 * g_set_application_name() has not been called, returns the result of
1075 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1078 * Returns: human-readable application name. may return %NULL
1083 g_get_application_name (void)
1087 G_LOCK (g_application_name);
1088 retval = g_application_name;
1089 G_UNLOCK (g_application_name);
1092 return g_get_prgname ();
1098 * g_set_application_name:
1099 * @application_name: localized name of the application
1101 * Sets a human-readable name for the application. This name should be
1102 * localized if possible, and is intended for display to the user.
1103 * Contrast with g_set_prgname(), which sets a non-localized name.
1104 * g_set_prgname() will be called automatically by gtk_init(),
1105 * but g_set_application_name() will not.
1107 * Note that for thread safety reasons, this function can only
1110 * The application name will be used in contexts such as error messages,
1111 * or when displaying an application's name in the task list.
1116 g_set_application_name (const gchar *application_name)
1118 gboolean already_set = FALSE;
1120 G_LOCK (g_application_name);
1121 if (g_application_name)
1124 g_application_name = g_strdup (application_name);
1125 G_UNLOCK (g_application_name);
1128 g_warning ("g_set_application_name() called multiple times");
1132 * g_get_user_data_dir:
1134 * Returns a base directory in which to access application data such
1135 * as icons that is customized for a particular user.
1137 * On UNIX platforms this is determined using the mechanisms described
1139 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1140 * In this case the directory retrieved will be `XDG_DATA_HOME`.
1142 * On Windows this is the folder to use for local (as opposed to
1143 * roaming) application data. See documentation for
1144 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1145 * what g_get_user_config_dir() returns.
1147 * Returns: a string owned by GLib that must not be modified
1152 g_get_user_data_dir (void)
1156 G_LOCK (g_utils_global);
1158 if (!g_user_data_dir)
1161 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1163 data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1165 if (data_dir && data_dir[0])
1166 data_dir = g_strdup (data_dir);
1168 if (!data_dir || !data_dir[0])
1170 const gchar *home_dir = g_get_home_dir ();
1173 data_dir = g_build_filename (home_dir, ".local", "share", NULL);
1175 data_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".local", "share", NULL);
1178 g_user_data_dir = data_dir;
1181 data_dir = g_user_data_dir;
1183 G_UNLOCK (g_utils_global);
1189 g_init_user_config_dir (void)
1193 if (!g_user_config_dir)
1196 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1198 config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1200 if (config_dir && config_dir[0])
1201 config_dir = g_strdup (config_dir);
1203 if (!config_dir || !config_dir[0])
1205 const gchar *home_dir = g_get_home_dir ();
1208 config_dir = g_build_filename (home_dir, ".config", NULL);
1210 config_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".config", NULL);
1213 g_user_config_dir = config_dir;
1218 * g_get_user_config_dir:
1220 * Returns a base directory in which to store user-specific application
1221 * configuration information such as user preferences and settings.
1223 * On UNIX platforms this is determined using the mechanisms described
1225 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1226 * In this case the directory retrieved will be `XDG_CONFIG_HOME`.
1228 * On Windows this is the folder to use for local (as opposed to
1229 * roaming) application data. See documentation for
1230 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1231 * what g_get_user_data_dir() returns.
1233 * Returns: a string owned by GLib that must not be modified
1238 g_get_user_config_dir (void)
1240 G_LOCK (g_utils_global);
1242 g_init_user_config_dir ();
1244 G_UNLOCK (g_utils_global);
1246 return g_user_config_dir;
1250 * g_get_user_cache_dir:
1252 * Returns a base directory in which to store non-essential, cached
1253 * data specific to particular user.
1255 * On UNIX platforms this is determined using the mechanisms described
1257 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1258 * In this case the directory retrieved will be XDG_CACHE_HOME.
1260 * On Windows is the directory that serves as a common repository for
1261 * temporary Internet files. A typical path is
1262 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1263 * See documentation for CSIDL_INTERNET_CACHE.
1265 * Returns: a string owned by GLib that must not be modified
1270 g_get_user_cache_dir (void)
1274 G_LOCK (g_utils_global);
1276 if (!g_user_cache_dir)
1279 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1281 cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1283 if (cache_dir && cache_dir[0])
1284 cache_dir = g_strdup (cache_dir);
1286 if (!cache_dir || !cache_dir[0])
1288 const gchar *home_dir = g_get_home_dir ();
1291 cache_dir = g_build_filename (home_dir, ".cache", NULL);
1293 cache_dir = g_build_filename (g_get_tmp_dir (), g_get_user_name (), ".cache", NULL);
1295 g_user_cache_dir = cache_dir;
1298 cache_dir = g_user_cache_dir;
1300 G_UNLOCK (g_utils_global);
1306 * g_get_user_runtime_dir:
1308 * Returns a directory that is unique to the current user on the local
1311 * On UNIX platforms this is determined using the mechanisms described
1313 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1314 * This is the directory
1315 * specified in the `XDG_RUNTIME_DIR` environment variable.
1316 * In the case that this variable is not set, GLib will issue a warning
1317 * message to stderr and return the value of g_get_user_cache_dir().
1319 * On Windows this is the folder to use for local (as opposed to
1320 * roaming) application data. See documentation for
1321 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1322 * what g_get_user_config_dir() returns.
1324 * Returns: a string owned by GLib that must not be modified or freed.
1329 g_get_user_runtime_dir (void)
1332 static const gchar *runtime_dir;
1333 static gsize initialised;
1335 if (g_once_init_enter (&initialised))
1337 runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1339 g_once_init_leave (&initialised, 1);
1345 /* Both fallback for UNIX and the default
1346 * in Windows: use the user cache directory.
1350 return g_get_user_cache_dir ();
1356 find_folder (OSType type)
1358 gchar *filename = NULL;
1361 if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1363 CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1367 CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1371 filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1375 filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1377 CFStringGetCString (path, filename,
1378 CFStringGetLength (path) * 3 + 1,
1379 kCFStringEncodingUTF8);
1393 load_user_special_dirs (void)
1395 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1396 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1397 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1398 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1399 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1400 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1401 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1402 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1405 #endif /* HAVE_CARBON */
1407 #if defined(G_OS_WIN32)
1409 load_user_special_dirs (void)
1411 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1415 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1417 static const GUID FOLDERID_Downloads =
1418 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1419 static const GUID FOLDERID_Public =
1420 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1424 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1425 "SHGetKnownFolderPath");
1427 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1428 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1430 if (p_SHGetKnownFolderPath == NULL)
1432 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1437 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1440 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1441 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1442 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1443 CoTaskMemFree (wcp);
1446 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1449 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1450 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1452 if (p_SHGetKnownFolderPath == NULL)
1455 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1460 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1463 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1464 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1465 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1466 CoTaskMemFree (wcp);
1469 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1472 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1473 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1475 #endif /* G_OS_WIN32 */
1478 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1480 /* adapted from xdg-user-dir-lookup.c
1482 * Copyright (C) 2007 Red Hat Inc.
1484 * Permission is hereby granted, free of charge, to any person
1485 * obtaining a copy of this software and associated documentation files
1486 * (the "Software"), to deal in the Software without restriction,
1487 * including without limitation the rights to use, copy, modify, merge,
1488 * publish, distribute, sublicense, and/or sell copies of the Software,
1489 * and to permit persons to whom the Software is furnished to do so,
1490 * subject to the following conditions:
1492 * The above copyright notice and this permission notice shall be
1493 * included in all copies or substantial portions of the Software.
1495 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1496 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1497 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1498 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1499 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1500 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1501 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1505 load_user_special_dirs (void)
1512 g_init_user_config_dir ();
1513 config_file = g_build_filename (g_user_config_dir,
1517 if (!g_file_get_contents (config_file, &data, NULL, NULL))
1519 g_free (config_file);
1523 lines = g_strsplit (data, "\n", -1);
1524 n_lines = g_strv_length (lines);
1527 for (i = 0; i < n_lines; i++)
1529 gchar *buffer = lines[i];
1532 gboolean is_relative = FALSE;
1533 GUserDirectory directory;
1535 /* Remove newline at end */
1536 len = strlen (buffer);
1537 if (len > 0 && buffer[len - 1] == '\n')
1538 buffer[len - 1] = 0;
1541 while (*p == ' ' || *p == '\t')
1544 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1546 directory = G_USER_DIRECTORY_DESKTOP;
1547 p += strlen ("XDG_DESKTOP_DIR");
1549 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1551 directory = G_USER_DIRECTORY_DOCUMENTS;
1552 p += strlen ("XDG_DOCUMENTS_DIR");
1554 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1556 directory = G_USER_DIRECTORY_DOWNLOAD;
1557 p += strlen ("XDG_DOWNLOAD_DIR");
1559 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1561 directory = G_USER_DIRECTORY_MUSIC;
1562 p += strlen ("XDG_MUSIC_DIR");
1564 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1566 directory = G_USER_DIRECTORY_PICTURES;
1567 p += strlen ("XDG_PICTURES_DIR");
1569 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1571 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1572 p += strlen ("XDG_PUBLICSHARE_DIR");
1574 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1576 directory = G_USER_DIRECTORY_TEMPLATES;
1577 p += strlen ("XDG_TEMPLATES_DIR");
1579 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1581 directory = G_USER_DIRECTORY_VIDEOS;
1582 p += strlen ("XDG_VIDEOS_DIR");
1587 while (*p == ' ' || *p == '\t')
1594 while (*p == ' ' || *p == '\t')
1601 if (strncmp (p, "$HOME", 5) == 0)
1609 d = strrchr (p, '"');
1616 /* remove trailing slashes */
1618 if (d[len - 1] == '/')
1623 g_user_special_dirs[directory] = g_build_filename (g_get_home_dir (), d, NULL);
1626 g_user_special_dirs[directory] = g_strdup (d);
1630 g_free (config_file);
1633 #endif /* G_OS_UNIX && !HAVE_CARBON */
1637 * g_reload_user_special_dirs_cache:
1639 * Resets the cache used for g_get_user_special_dir(), so
1640 * that the latest on-disk version is used. Call this only
1641 * if you just changed the data on disk yourself.
1643 * Due to threadsafety issues this may cause leaking of strings
1644 * that were previously returned from g_get_user_special_dir()
1645 * that can't be freed. We ensure to only leak the data for
1646 * the directories that actually changed value though.
1651 g_reload_user_special_dirs_cache (void)
1655 G_LOCK (g_utils_global);
1657 if (g_user_special_dirs != NULL)
1659 /* save a copy of the pointer, to check if some memory can be preserved */
1660 char **old_g_user_special_dirs = g_user_special_dirs;
1663 /* recreate and reload our cache */
1664 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1665 load_user_special_dirs ();
1667 /* only leak changed directories */
1668 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1670 old_val = old_g_user_special_dirs[i];
1671 if (g_user_special_dirs[i] == NULL)
1673 g_user_special_dirs[i] = old_val;
1675 else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1678 g_free (g_user_special_dirs[i]);
1679 g_user_special_dirs[i] = old_val;
1685 /* free the old array */
1686 g_free (old_g_user_special_dirs);
1689 G_UNLOCK (g_utils_global);
1693 * g_get_user_special_dir:
1694 * @directory: the logical id of special directory
1696 * Returns the full path of a special directory using its logical id.
1698 * On UNIX this is done using the XDG special user directories.
1699 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1700 * falls back to `$HOME/Desktop` when XDG special user directories have
1703 * Depending on the platform, the user might be able to change the path
1704 * of the special directory without requiring the session to restart; GLib
1705 * will not reflect any change once the special directories are loaded.
1707 * Returns: the path to the specified special directory, or %NULL
1708 * if the logical id was not found. The returned string is owned by
1709 * GLib and should not be modified or freed.
1714 g_get_user_special_dir (GUserDirectory directory)
1716 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1717 directory < G_USER_N_DIRECTORIES, NULL);
1719 G_LOCK (g_utils_global);
1721 if (G_UNLIKELY (g_user_special_dirs == NULL))
1723 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1725 load_user_special_dirs ();
1727 /* Special-case desktop for historical compatibility */
1728 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1729 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = g_build_filename (g_get_home_dir (), "Desktop", NULL);
1732 G_UNLOCK (g_utils_global);
1734 return g_user_special_dirs[directory];
1739 #undef g_get_system_data_dirs
1742 get_module_for_address (gconstpointer address)
1744 /* Holds the g_utils_global lock */
1746 static gboolean beenhere = FALSE;
1747 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1748 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1749 HMODULE hmodule = NULL;
1756 p_GetModuleHandleExA =
1757 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1758 "GetModuleHandleExA");
1762 if (p_GetModuleHandleExA == NULL ||
1763 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1764 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1767 MEMORY_BASIC_INFORMATION mbi;
1768 VirtualQuery (address, &mbi, sizeof (mbi));
1769 hmodule = (HMODULE) mbi.AllocationBase;
1776 get_module_share_dir (gconstpointer address)
1782 hmodule = get_module_for_address (address);
1783 if (hmodule == NULL)
1786 filename = g_win32_get_package_installation_directory_of_module (hmodule);
1787 retval = g_build_filename (filename, "share", NULL);
1793 const gchar * const *
1794 g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
1798 static GHashTable *per_module_data_dirs = NULL;
1803 if (address_of_function)
1805 G_LOCK (g_utils_global);
1806 hmodule = get_module_for_address (address_of_function);
1807 if (hmodule != NULL)
1809 if (per_module_data_dirs == NULL)
1810 per_module_data_dirs = g_hash_table_new (NULL, NULL);
1813 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1817 G_UNLOCK (g_utils_global);
1818 return (const gchar * const *) retval;
1824 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1826 /* Documents and Settings\All Users\Application Data */
1827 p = get_special_folder (CSIDL_COMMON_APPDATA);
1829 g_array_append_val (data_dirs, p);
1831 /* Documents and Settings\All Users\Documents */
1832 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1834 g_array_append_val (data_dirs, p);
1836 /* Using the above subfolders of Documents and Settings perhaps
1837 * makes sense from a Windows perspective.
1839 * But looking at the actual use cases of this function in GTK+
1840 * and GNOME software, what we really want is the "share"
1841 * subdirectory of the installation directory for the package
1842 * our caller is a part of.
1844 * The address_of_function parameter, if non-NULL, points to a
1845 * function in the calling module. Use that to determine that
1846 * module's installation folder, and use its "share" subfolder.
1848 * Additionally, also use the "share" subfolder of the installation
1849 * locations of GLib and the .exe file being run.
1851 * To guard against none of the above being what is really wanted,
1852 * callers of this function should have Win32-specific code to look
1853 * up their installation folder themselves, and handle a subfolder
1854 * "share" of it in the same way as the folders returned from this
1858 p = get_module_share_dir (address_of_function);
1860 g_array_append_val (data_dirs, p);
1862 if (glib_dll != NULL)
1864 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1865 p = g_build_filename (glib_root, "share", NULL);
1867 g_array_append_val (data_dirs, p);
1871 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1872 p = g_build_filename (exe_root, "share", NULL);
1874 g_array_append_val (data_dirs, p);
1877 retval = (gchar **) g_array_free (data_dirs, FALSE);
1879 if (address_of_function)
1881 if (hmodule != NULL)
1882 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1883 G_UNLOCK (g_utils_global);
1886 return (const gchar * const *) retval;
1892 * g_get_system_data_dirs:
1894 * Returns an ordered list of base directories in which to access
1895 * system-wide application data.
1897 * On UNIX platforms this is determined using the mechanisms described
1899 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec)
1900 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1902 * On Windows the first elements in the list are the Application Data
1903 * and Documents folders for All Users. (These can be determined only
1904 * on Windows 2000 or later and are not present in the list on other
1905 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1906 * CSIDL_COMMON_DOCUMENTS.
1908 * Then follows the "share" subfolder in the installation folder for
1909 * the package containing the DLL that calls this function, if it can
1912 * Finally the list contains the "share" subfolder in the installation
1913 * folder for GLib, and in the installation folder for the package the
1914 * application's .exe file belongs to.
1916 * The installation folders above are determined by looking up the
1917 * folder where the module (DLL or EXE) in question is located. If the
1918 * folder's name is "bin", its parent is used, otherwise the folder
1921 * Note that on Windows the returned list can vary depending on where
1922 * this function is called.
1924 * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1925 * not be modified or freed.
1928 const gchar * const *
1929 g_get_system_data_dirs (void)
1931 gchar **data_dir_vector;
1933 G_LOCK (g_utils_global);
1935 if (!g_system_data_dirs)
1938 data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
1940 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
1942 if (!data_dirs || !data_dirs[0])
1943 data_dirs = "/usr/local/share/:/usr/share/";
1945 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
1948 g_system_data_dirs = data_dir_vector;
1951 data_dir_vector = g_system_data_dirs;
1953 G_UNLOCK (g_utils_global);
1955 return (const gchar * const *) data_dir_vector;
1959 * g_get_system_config_dirs:
1961 * Returns an ordered list of base directories in which to access
1962 * system-wide configuration information.
1964 * On UNIX platforms this is determined using the mechanisms described
1966 * [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
1967 * In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.
1969 * On Windows is the directory that contains application data for all users.
1970 * A typical path is C:\Documents and Settings\All Users\Application Data.
1971 * This folder is used for application data that is not user specific.
1972 * For example, an application can store a spell-check dictionary, a database
1973 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
1974 * This information will not roam and is available to anyone using the computer.
1976 * Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1977 * not be modified or freed.
1980 const gchar * const *
1981 g_get_system_config_dirs (void)
1983 gchar *conf_dirs, **conf_dir_vector;
1985 G_LOCK (g_utils_global);
1987 if (!g_system_config_dirs)
1990 conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
1993 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
1998 /* Return empty list */
1999 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2002 conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2004 if (!conf_dirs || !conf_dirs[0])
2005 conf_dirs = "/etc/xdg";
2007 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2010 g_system_config_dirs = conf_dir_vector;
2013 conf_dir_vector = g_system_config_dirs;
2014 G_UNLOCK (g_utils_global);
2016 return (const gchar * const *) conf_dir_vector;
2020 * g_nullify_pointer:
2021 * @nullify_location: the memory address of the pointer.
2023 * Set the pointer at the specified location to %NULL.
2026 g_nullify_pointer (gpointer *nullify_location)
2028 g_return_if_fail (nullify_location != NULL);
2030 *nullify_location = NULL;
2033 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2034 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2035 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2036 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2037 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2038 #define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2040 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2041 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2042 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2043 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2044 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2045 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2049 * @size: a size in bytes
2051 * Formats a size (for example the size of a file) into a human readable
2052 * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
2053 * and are displayed rounded to the nearest tenth. E.g. the file size
2054 * 3292528 bytes will be converted into the string "3.2 MB".
2056 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2058 * This string should be freed with g_free() when not needed any longer.
2060 * See g_format_size_full() for more options about how the size might be
2063 * Returns: a newly-allocated formatted string containing a human readable
2069 g_format_size (guint64 size)
2071 return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2076 * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2077 * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2078 * of the returned string. For example, "45.6 kB (45,612 bytes)".
2079 * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2080 * suffixes. IEC units should only be used for reporting things with
2081 * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2082 * Network and storage sizes should be reported in the normal SI units.
2084 * Flags to modify the format of the string returned by g_format_size_full().
2087 #pragma GCC diagnostic push
2088 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
2091 * g_format_size_full:
2092 * @size: a size in bytes
2093 * @flags: #GFormatSizeFlags to modify the output
2097 * This function is similar to g_format_size() but allows for flags
2098 * that modify the output. See #GFormatSizeFlags.
2100 * Returns: a newly-allocated formatted string containing a human
2101 * readable file size
2106 g_format_size_full (guint64 size,
2107 GFormatSizeFlags flags)
2111 string = g_string_new (NULL);
2113 if (flags & G_FORMAT_SIZE_IEC_UNITS)
2115 if (size < KIBIBYTE_FACTOR)
2117 g_string_printf (string,
2118 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2120 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2123 else if (size < MEBIBYTE_FACTOR)
2124 g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2125 else if (size < GIBIBYTE_FACTOR)
2126 g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2128 else if (size < TEBIBYTE_FACTOR)
2129 g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2131 else if (size < PEBIBYTE_FACTOR)
2132 g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2134 else if (size < EXBIBYTE_FACTOR)
2135 g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2138 g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2142 if (size < KILOBYTE_FACTOR)
2144 g_string_printf (string,
2145 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2147 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2150 else if (size < MEGABYTE_FACTOR)
2151 g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2153 else if (size < GIGABYTE_FACTOR)
2154 g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2156 else if (size < TERABYTE_FACTOR)
2157 g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2158 else if (size < PETABYTE_FACTOR)
2159 g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2161 else if (size < EXABYTE_FACTOR)
2162 g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2165 g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2168 if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2170 /* First problem: we need to use the number of bytes to decide on
2171 * the plural form that is used for display, but the number of
2172 * bytes potentially exceeds the size of a guint (which is what
2173 * ngettext() takes).
2175 * From a pragmatic standpoint, it seems that all known languages
2176 * base plural forms on one or both of the following:
2178 * - the lowest digits of the number
2180 * - if the number if greater than some small value
2182 * Here's how we fake it: Draw an arbitrary line at one thousand.
2183 * If the number is below that, then fine. If it is above it,
2184 * then we take the modulus of the number by one thousand (in
2185 * order to keep the lowest digits) and add one thousand to that
2186 * (in order to ensure that 1001 is not treated the same as 1).
2188 guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2190 /* Second problem: we need to translate the string "%u byte" and
2191 * "%u bytes" for pluralisation, but the correct number format to
2192 * use for a gsize is different depending on which architecture
2195 * Solution: format the number separately and use "%s bytes" on
2198 const gchar *translated_format;
2199 gchar *formatted_number;
2201 /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2202 translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2203 /* XXX: Windows doesn't support the "'" format modifier, so we
2204 * must not use it there. Instead, just display the number
2205 * without separation. Bug #655336 is open until a solution is
2209 formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2211 formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2214 g_string_append (string, " (");
2215 g_string_append_printf (string, translated_format, formatted_number);
2216 g_free (formatted_number);
2217 g_string_append (string, ")");
2220 return g_string_free (string, FALSE);
2223 #pragma GCC diagnostic pop
2226 * g_format_size_for_display:
2227 * @size: a size in bytes
2229 * Formats a size (for example the size of a file) into a human
2230 * readable string. Sizes are rounded to the nearest size prefix
2231 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2232 * E.g. the file size 3292528 bytes will be converted into the
2235 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2237 * This string should be freed with g_free() when not needed any longer.
2239 * Returns: a newly-allocated formatted string containing a human
2240 * readable file size
2244 * Deprecated:2.30: This function is broken due to its use of SI
2245 * suffixes to denote IEC units. Use g_format_size() instead.
2248 g_format_size_for_display (goffset size)
2250 if (size < (goffset) KIBIBYTE_FACTOR)
2251 return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2254 gdouble displayed_size;
2256 if (size < (goffset) MEBIBYTE_FACTOR)
2258 displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2259 /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
2260 * mean 1024 bytes. I am aware that 'KB' is not correct, but it has been preserved for reasons of
2261 * compatibility. Users will not see this string unless a program is using this deprecated function.
2262 * Please translate as literally as possible.
2264 return g_strdup_printf (_("%.1f KB"), displayed_size);
2266 else if (size < (goffset) GIBIBYTE_FACTOR)
2268 displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2269 return g_strdup_printf (_("%.1f MB"), displayed_size);
2271 else if (size < (goffset) TEBIBYTE_FACTOR)
2273 displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2274 return g_strdup_printf (_("%.1f GB"), displayed_size);
2276 else if (size < (goffset) PEBIBYTE_FACTOR)
2278 displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2279 return g_strdup_printf (_("%.1f TB"), displayed_size);
2281 else if (size < (goffset) EXBIBYTE_FACTOR)
2283 displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2284 return g_strdup_printf (_("%.1f PB"), displayed_size);
2288 displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2289 return g_strdup_printf (_("%.1f EB"), displayed_size);
2294 #if defined (G_OS_WIN32) && !defined (_WIN64)
2296 /* Binary compatibility versions. Not for newly compiled code. */
2298 _GLIB_EXTERN const gchar *g_get_user_name_utf8 (void);
2299 _GLIB_EXTERN const gchar *g_get_real_name_utf8 (void);
2300 _GLIB_EXTERN const gchar *g_get_home_dir_utf8 (void);
2301 _GLIB_EXTERN const gchar *g_get_tmp_dir_utf8 (void);
2302 _GLIB_EXTERN gchar *g_find_program_in_path_utf8 (const gchar *program);
2305 g_find_program_in_path_utf8 (const gchar *program)
2307 return g_find_program_in_path (program);
2310 const gchar *g_get_user_name_utf8 (void) { return g_get_user_name (); }
2311 const gchar *g_get_real_name_utf8 (void) { return g_get_real_name (); }
2312 const gchar *g_get_home_dir_utf8 (void) { return g_get_home_dir (); }
2313 const gchar *g_get_tmp_dir_utf8 (void) { return g_get_tmp_dir (); }
2319 * Returns %TRUE if the current process was executed as setuid (or an
2320 * equivalent __libc_enable_secure is available). See:
2321 * http://osdir.com/ml/linux.lfs.hardened/2007-04/msg00032.html
2324 g_check_setuid (void)
2326 /* TODO: get __libc_enable_secure exported from glibc.
2327 * See http://www.openwall.com/lists/owl-dev/2012/08/14/1
2329 #if 0 && defined(HAVE_LIBC_ENABLE_SECURE)
2331 /* See glibc/include/unistd.h */
2332 extern int __libc_enable_secure;
2333 return __libc_enable_secure;
2335 #elif defined(HAVE_ISSETUGID)
2336 /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
2337 return issetugid ();
2338 #elif defined(G_OS_UNIX)
2339 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
2340 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
2342 static gsize check_setuid_initialised;
2343 static gboolean is_setuid;
2345 if (g_once_init_enter (&check_setuid_initialised))
2347 #ifdef HAVE_GETRESUID
2348 /* These aren't in the header files, so we prototype them here.
2350 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
2351 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
2353 if (getresuid (&ruid, &euid, &suid) != 0 ||
2354 getresgid (&rgid, &egid, &sgid) != 0)
2355 #endif /* HAVE_GETRESUID */
2357 suid = ruid = getuid ();
2358 sgid = rgid = getgid ();
2363 is_setuid = (ruid != euid || ruid != suid ||
2364 rgid != egid || rgid != sgid);
2366 g_once_init_leave (&check_setuid_initialised, 1);