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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
28 * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
41 #include <ctype.h> /* For tolower() */
43 #include <sys/types.h>
48 #include <sys/types.h>
49 #ifdef HAVE_SYS_PARAM_H
50 #include <sys/param.h>
52 #ifdef HAVE_CRT_EXTERNS_H
53 #include <crt_externs.h> /* for _NSGetEnviron */
56 /* implement gutils's inline functions
58 #define G_IMPLEMENT_INLINES 1
62 #include "glib-init.h"
63 #include "glib-private.h"
65 #include "gfileutils.h"
69 #include "gtestutils.h"
71 #include "gstrfuncs.h"
75 #ifdef G_PLATFORM_WIN32
83 * @title: Miscellaneous Utility Functions
84 * @short_description: a selection of portable utility functions
86 * These are portable utility functions.
89 #ifdef G_PLATFORM_WIN32
91 # ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
92 # define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
93 # define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
95 # include <lmcons.h> /* For UNLEN */
96 #endif /* G_PLATFORM_WIN32 */
101 /* older SDK (e.g. msvc 5.0) does not have these*/
102 # ifndef CSIDL_MYMUSIC
103 # define CSIDL_MYMUSIC 13
105 # ifndef CSIDL_MYVIDEO
106 # define CSIDL_MYVIDEO 14
108 # ifndef CSIDL_INTERNET_CACHE
109 # define CSIDL_INTERNET_CACHE 32
111 # ifndef CSIDL_COMMON_APPDATA
112 # define CSIDL_COMMON_APPDATA 35
114 # ifndef CSIDL_MYPICTURES
115 # define CSIDL_MYPICTURES 0x27
117 # ifndef CSIDL_COMMON_DOCUMENTS
118 # define CSIDL_COMMON_DOCUMENTS 46
120 # ifndef CSIDL_PROFILE
121 # define CSIDL_PROFILE 40
123 # include <process.h>
127 #include <CoreServices/CoreServices.h>
131 #include <langinfo.h>
134 #ifdef G_PLATFORM_WIN32
137 _glib_get_dll_directory (void)
141 wchar_t wc_fn[MAX_PATH];
144 if (glib_dll == NULL)
148 /* This code is different from that in
149 * g_win32_get_package_installation_directory_of_module() in that
150 * here we return the actual folder where the GLib DLL is. We don't
151 * do the check for it being in a "bin" or "lib" subfolder and then
152 * returning the parent of that.
154 * In a statically built GLib, glib_dll will be NULL and we will
155 * thus look up the application's .exe file's location.
157 if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
160 retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
162 p = strrchr (retval, G_DIR_SEPARATOR);
175 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
178 * @dest: the destination address to copy the bytes to.
179 * @src: the source address to copy the bytes from.
180 * @len: the number of bytes to copy.
182 * Copies a block of memory @len bytes long, from @src to @dest.
183 * The source and destination areas may overlap.
185 * In order to use this function, you must include
186 * <filename>string.h</filename> yourself, because this macro will
187 * typically simply resolve to memmove() and GLib does not include
188 * <filename>string.h</filename> for you.
191 g_memmove (gpointer dest,
195 gchar* destptr = dest;
196 const gchar* srcptr = src;
197 if (src + len < dest || dest + len < src)
199 bcopy (src, dest, len);
202 else if (dest <= src)
205 *(destptr++) = *(srcptr++);
212 *(--destptr) = *(--srcptr);
215 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
223 * @func: (scope async): the function to call on normal program termination.
225 * Specifies a function to be called at normal program termination.
227 * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
228 * macro that maps to a call to the atexit() function in the C
229 * library. This means that in case the code that calls g_atexit(),
230 * i.e. atexit(), is in a DLL, the function will be called when the
231 * DLL is detached from the program. This typically makes more sense
232 * than that the function is called when the GLib DLL is detached,
233 * which happened earlier when g_atexit() was a function in the GLib
236 * The behaviour of atexit() in the context of dynamically loaded
237 * modules is not formally specified and varies wildly.
239 * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
240 * loaded module which is unloaded before the program terminates might
241 * well cause a crash at program exit.
243 * Some POSIX systems implement atexit() like Windows, and have each
244 * dynamically loaded module maintain an own atexit chain that is
245 * called when the module is unloaded.
247 * On other POSIX systems, before a dynamically loaded module is
248 * unloaded, the registered atexit functions (if any) residing in that
249 * module are called, regardless where the code that registered them
250 * resided. This is presumably the most robust approach.
252 * As can be seen from the above, for portability it's best to avoid
253 * calling g_atexit() (or atexit()) except in the main executable of a
256 * Deprecated:2.32: It is best to avoid g_atexit().
259 g_atexit (GVoidFunc func)
262 const gchar *error = NULL;
264 /* keep this in sync with glib.h */
266 #ifdef G_NATIVE_ATEXIT
267 result = ATEXIT (func);
269 error = g_strerror (errno);
270 #elif defined (HAVE_ATEXIT)
271 # ifdef NeXT /* @#%@! NeXTStep */
272 result = !atexit ((void (*)(void)) func);
274 error = g_strerror (errno);
276 result = atexit ((void (*)(void)) func);
278 error = g_strerror (errno);
280 #elif defined (HAVE_ON_EXIT)
281 result = on_exit ((void (*)(int, void *)) func, NULL);
283 error = g_strerror (errno);
286 error = "no implementation";
287 #endif /* G_NATIVE_ATEXIT */
290 g_error ("Could not register atexit() function: %s", error);
293 /* Based on execvp() from GNU Libc.
294 * Some of this code is cut-and-pasted into gspawn.c
298 my_strchrnul (const gchar *str,
301 gchar *p = (gchar*)str;
302 while (*p && (*p != c))
310 static gchar *inner_find_program_in_path (const gchar *program);
313 g_find_program_in_path (const gchar *program)
315 const gchar *last_dot = strrchr (program, '.');
317 if (last_dot == NULL ||
318 strchr (last_dot, '\\') != NULL ||
319 strchr (last_dot, '/') != NULL)
321 const gint program_length = strlen (program);
322 gchar *pathext = g_build_path (";",
323 ".exe;.cmd;.bat;.com",
324 g_getenv ("PATHEXT"),
327 gchar *decorated_program;
333 gchar *q = my_strchrnul (p, ';');
335 decorated_program = g_malloc (program_length + (q-p) + 1);
336 memcpy (decorated_program, program, program_length);
337 memcpy (decorated_program+program_length, p, q-p);
338 decorated_program [program_length + (q-p)] = '\0';
340 retval = inner_find_program_in_path (decorated_program);
341 g_free (decorated_program);
349 } while (*p++ != '\0');
354 return inner_find_program_in_path (program);
360 * g_find_program_in_path:
361 * @program: a program name in the GLib file name encoding
363 * Locates the first executable named @program in the user's path, in the
364 * same way that execvp() would locate it. Returns an allocated string
365 * with the absolute path name, or %NULL if the program is not found in
366 * the path. If @program is already an absolute path, returns a copy of
367 * @program if @program exists and is executable, and %NULL otherwise.
369 * On Windows, if @program does not have a file type suffix, tries
370 * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
371 * the <envar>PATHEXT</envar> environment variable.
373 * On Windows, it looks for the file in the same way as CreateProcess()
374 * would. This means first in the directory where the executing
375 * program was loaded from, then in the current directory, then in the
376 * Windows 32-bit system directory, then in the Windows directory, and
377 * finally in the directories in the <envar>PATH</envar> environment
378 * variable. If the program is found, the return value contains the
379 * full name including the type suffix.
381 * Return value: a newly-allocated string with the absolute path, or %NULL
385 inner_find_program_in_path (const gchar *program)
388 g_find_program_in_path (const gchar *program)
391 const gchar *path, *p;
392 gchar *name, *freeme;
394 const gchar *path_copy;
395 gchar *filename = NULL, *appdir = NULL;
396 gchar *sysdir = NULL, *windir = NULL;
398 wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
404 g_return_val_if_fail (program != NULL, NULL);
406 /* If it is an absolute path, or a relative path including subdirectories,
407 * don't look in PATH.
409 if (g_path_is_absolute (program)
410 || strchr (program, G_DIR_SEPARATOR) != NULL
412 || strchr (program, '/') != NULL
416 if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
417 !g_file_test (program, G_FILE_TEST_IS_DIR))
418 return g_strdup (program);
423 path = g_getenv ("PATH");
424 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
427 /* There is no `PATH' in the environment. The default
428 * search path in GNU libc is the current directory followed by
429 * the path `confstr' returns for `_CS_PATH'.
432 /* In GLib we put . last, for security, and don't use the
433 * unportable confstr(); UNIX98 does not actually specify
434 * what to search if PATH is unset. POSIX may, dunno.
437 path = "/bin:/usr/bin:.";
440 n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
441 if (n > 0 && n < MAXPATHLEN)
442 filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
444 n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
445 if (n > 0 && n < MAXPATHLEN)
446 sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
448 n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
449 if (n > 0 && n < MAXPATHLEN)
450 windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
454 appdir = g_path_get_dirname (filename);
458 path = g_strdup (path);
462 const gchar *tem = path;
463 path = g_strconcat (windir, ";", path, NULL);
464 g_free ((gchar *) tem);
470 const gchar *tem = path;
471 path = g_strconcat (sysdir, ";", path, NULL);
472 g_free ((gchar *) tem);
477 const gchar *tem = path;
478 path = g_strconcat (".;", path, NULL);
479 g_free ((gchar *) tem);
484 const gchar *tem = path;
485 path = g_strconcat (appdir, ";", path, NULL);
486 g_free ((gchar *) tem);
493 len = strlen (program) + 1;
494 pathlen = strlen (path);
495 freeme = name = g_malloc (pathlen + len + 1);
497 /* Copy the file name at the top, including '\0' */
498 memcpy (name + pathlen + 1, program, len);
499 name = name + pathlen;
500 /* And add the slash before the filename */
501 *name = G_DIR_SEPARATOR;
509 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
512 /* Two adjacent colons, or a colon at the beginning or the end
513 * of `PATH' means to search the current directory.
517 startp = memcpy (name - (p - path), path, p - path);
519 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
520 !g_file_test (startp, G_FILE_TEST_IS_DIR))
523 ret = g_strdup (startp);
526 g_free ((gchar *) path_copy);
531 while (*p++ != '\0');
535 g_free ((gchar *) path_copy);
543 * @mask: a #gulong containing flags
544 * @nth_bit: the index of the bit to start the search from
546 * Find the position of the first bit set in @mask, searching
547 * from (but not including) @nth_bit upwards. Bits are numbered
548 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
549 * usually). To start searching from the 0th bit, set @nth_bit to -1.
551 * Returns: the index of the first bit set which is higher than @nth_bit
556 * @mask: a #gulong containing flags
557 * @nth_bit: the index of the bit to start the search from
559 * Find the position of the first bit set in @mask, searching
560 * from (but not including) @nth_bit downwards. Bits are numbered
561 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
562 * usually). To start searching from the last bit, set @nth_bit to
563 * -1 or GLIB_SIZEOF_LONG * 8.
565 * Returns: the index of the first bit set which is lower than @nth_bit
572 * Gets the number of bits used to hold @number,
573 * e.g. if @number is 4, 3 bits are needed.
575 * Returns: the number of bits used to hold @number
578 G_LOCK_DEFINE_STATIC (g_utils_global);
580 static gchar *g_tmp_dir = NULL;
581 static gchar *g_user_name = NULL;
582 static gchar *g_real_name = NULL;
583 static gchar *g_home_dir = NULL;
584 static gchar *g_host_name = NULL;
587 /* System codepage versions of the above, kept at file level so that they,
588 * too, are produced only once.
590 static gchar *g_tmp_dir_cp = NULL;
591 static gchar *g_user_name_cp = NULL;
592 static gchar *g_real_name_cp = NULL;
593 static gchar *g_home_dir_cp = NULL;
596 static gchar *g_user_data_dir = NULL;
597 static gchar **g_system_data_dirs = NULL;
598 static gchar *g_user_cache_dir = NULL;
599 static gchar *g_user_config_dir = NULL;
600 static gchar **g_system_config_dirs = NULL;
602 static gchar **g_user_special_dirs = NULL;
604 /* fifteen minutes of fame for everybody */
605 #define G_USER_DIRS_EXPIRE 15 * 60
610 get_special_folder (int csidl)
612 wchar_t path[MAX_PATH+1];
614 LPITEMIDLIST pidl = NULL;
616 gchar *retval = NULL;
618 hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
621 b = SHGetPathFromIDListW (pidl, path);
623 retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
624 CoTaskMemFree (pidl);
630 get_windows_directory_root (void)
632 wchar_t wwindowsdir[MAX_PATH];
634 if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
636 /* Usually X:\Windows, but in terminal server environments
637 * might be an UNC path, AFAIK.
639 char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
642 if (windowsdir == NULL)
643 return g_strdup ("C:\\");
645 p = (char *) g_path_skip_root (windowsdir);
646 if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
652 return g_strdup ("C:\\");
657 /* HOLDS: g_utils_global_lock */
659 g_get_any_init_do (void)
663 g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
665 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
668 g_tmp_dir = g_strdup (g_getenv ("TMP"));
671 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
674 g_tmp_dir = g_strdup (g_getenv ("TEMP"));
678 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
681 g_tmp_dir = get_windows_directory_root ();
686 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
690 g_tmp_dir = g_strdup (P_tmpdir);
691 k = strlen (g_tmp_dir);
692 if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
693 g_tmp_dir[k - 1] = '\0';
697 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
700 g_tmp_dir = g_strdup ("/tmp");
702 #endif /* !G_OS_WIN32 */
705 /* We check $HOME first for Win32, though it is a last resort for Unix
706 * where we prefer the results of getpwuid().
708 g_home_dir = g_strdup (g_getenv ("HOME"));
710 /* Only believe HOME if it is an absolute path and exists */
713 if (!(g_path_is_absolute (g_home_dir) &&
714 g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
721 /* In case HOME is Unix-style (it happens), convert it to
727 while ((p = strchr (g_home_dir, '/')) != NULL)
733 /* USERPROFILE is probably the closest equivalent to $HOME? */
734 if (g_getenv ("USERPROFILE") != NULL)
735 g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
739 g_home_dir = get_special_folder (CSIDL_PROFILE);
742 g_home_dir = get_windows_directory_root ();
743 #endif /* G_OS_WIN32 */
747 struct passwd *pw = NULL;
748 gpointer buffer = NULL;
752 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
754 # ifdef _SC_GETPW_R_SIZE_MAX
755 /* This reurns the maximum length */
756 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
760 # else /* _SC_GETPW_R_SIZE_MAX */
762 # endif /* _SC_GETPW_R_SIZE_MAX */
764 logname = (gchar *) g_getenv ("LOGNAME");
769 /* we allocate 6 extra bytes to work around a bug in
770 * Mac OS < 10.3. See #156446
772 buffer = g_malloc (bufsize + 6);
775 # ifdef HAVE_POSIX_GETPWUID_R
777 error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
778 if (!pw || (pw->pw_uid != getuid ())) {
779 /* LOGNAME is lying, fall back to looking up the uid */
780 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
783 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
785 error = error < 0 ? errno : error;
786 # else /* HAVE_NONPOSIX_GETPWUID_R */
787 /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
788 # if defined(_AIX) || defined(__hpux)
789 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
790 pw = error == 0 ? &pwd : NULL;
793 pw = getpwnam_r (logname, &pwd, buffer, bufsize);
794 if (!pw || (pw->pw_uid != getuid ())) {
795 /* LOGNAME is lying, fall back to looking up the uid */
796 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
799 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
801 error = pw ? 0 : errno;
803 # endif /* HAVE_NONPOSIX_GETPWUID_R */
807 /* we bail out prematurely if the user id can't be found
808 * (should be pretty rare case actually), or if the buffer
809 * should be sufficiently big and lookups are still not
812 if (error == 0 || error == ENOENT)
814 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
818 if (bufsize > 32 * 1024)
820 g_warning ("getpwuid_r(): failed due to: %s.",
829 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
836 pw = getpwuid (getuid ());
843 g_user_name = g_strdup (pw->pw_name);
846 if (pw->pw_gecos && *pw->pw_gecos != '\0')
848 gchar **gecos_fields;
851 /* split the gecos field and substitute '&' */
852 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
853 name_parts = g_strsplit (gecos_fields[0], "&", 0);
854 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
855 g_real_name = g_strjoinv (pw->pw_name, name_parts);
856 g_strfreev (gecos_fields);
857 g_strfreev (name_parts);
862 g_home_dir = g_strdup (pw->pw_dir);
867 #else /* !HAVE_PWD_H */
872 wchar_t buffer[UNLEN+1];
874 if (GetUserNameW (buffer, (LPDWORD) &len))
876 g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
877 g_real_name = g_strdup (g_user_name);
880 #endif /* G_OS_WIN32 */
882 #endif /* !HAVE_PWD_H */
886 g_home_dir = g_strdup (g_getenv ("HOME"));
890 /* change '\\' in %HOME% to '/' */
891 g_strdelimit (g_home_dir, "\\",'/');
894 g_user_name = g_strdup ("somebody");
896 g_real_name = g_strdup ("Unknown");
900 gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
902 DWORD size = sizeof (hostname);
903 gboolean hostname_fail = (!GetComputerName (hostname, &size));
905 g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
909 g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
910 g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
911 g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
914 g_tmp_dir_cp = g_strdup ("\\");
916 g_user_name_cp = g_strdup ("somebody");
918 g_real_name_cp = g_strdup ("Unknown");
920 /* home_dir might be NULL, unlike tmp_dir, user_name and
924 g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
926 g_home_dir_cp = NULL;
927 #endif /* G_OS_WIN32 */
931 g_get_any_init (void)
934 g_get_any_init_do ();
938 g_get_any_init_locked (void)
940 G_LOCK (g_utils_global);
942 G_UNLOCK (g_utils_global);
949 * Gets the user name of the current user. The encoding of the returned
950 * string is system-defined. On UNIX, it might be the preferred file name
951 * encoding, or something else, and there is no guarantee that it is even
952 * consistent on a machine. On Windows, it is always UTF-8.
954 * Returns: the user name of the current user.
957 g_get_user_name (void)
959 g_get_any_init_locked ();
966 * Gets the real name of the user. This usually comes from the user's entry
967 * in the <filename>passwd</filename> file. The encoding of the returned
968 * string is system-defined. (On Windows, it is, however, always UTF-8.)
969 * If the real user name cannot be determined, the string "Unknown" is
972 * Returns: the user's real name.
975 g_get_real_name (void)
977 g_get_any_init_locked ();
984 * Gets the current user's home directory as defined in the
987 * Note that in contrast to traditional UNIX tools, this function
988 * prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
989 * environment variable.
991 * One of the reasons for this decision is that applications in many
992 * cases need special handling to deal with the case where
993 * <envar>HOME</envar> is
995 * <member>Not owned by the user</member>
996 * <member>Not writeable</member>
997 * <member>Not even readable</member>
999 * Since applications are in general <emphasis>not</emphasis> written
1000 * to deal with these situations it was considered better to make
1001 * g_get_home_dir() not pay attention to <envar>HOME</envar> and to
1002 * return the real home directory for the user. If applications
1003 * want to pay attention to <envar>HOME</envar>, they can do:
1005 * const char *homedir = g_getenv ("HOME");
1007 * homedir = g_get_home_dir (<!-- -->);
1010 * Returns: the current user's home directory
1013 g_get_home_dir (void)
1015 g_get_any_init_locked ();
1022 * Gets the directory to use for temporary files. This is found from
1023 * inspecting the environment variables <envar>TMPDIR</envar>,
1024 * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
1025 * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
1026 * The encoding of the returned string is system-defined. On Windows,
1027 * it is always UTF-8. The return value is never %NULL or the empty string.
1029 * Returns: the directory to use for temporary files.
1032 g_get_tmp_dir (void)
1034 g_get_any_init_locked ();
1041 * Return a name for the machine.
1043 * The returned name is not necessarily a fully-qualified domain name,
1044 * or even present in DNS or some other name service at all. It need
1045 * not even be unique on your local network or site, but usually it
1046 * is. Callers should not rely on the return value having any specific
1047 * properties like uniqueness for security purposes. Even if the name
1048 * of the machine is changed while an application is running, the
1049 * return value from this function does not change. The returned
1050 * string is owned by GLib and should not be modified or freed. If no
1051 * name can be determined, a default fixed string "localhost" is
1054 * Returns: the host name of the machine.
1059 g_get_host_name (void)
1061 g_get_any_init_locked ();
1065 G_LOCK_DEFINE_STATIC (g_prgname);
1066 static gchar *g_prgname = NULL;
1071 * Gets the name of the program. This name should <emphasis>not</emphasis>
1072 * be localized, contrast with g_get_application_name().
1073 * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1074 * which is called by gtk_init(). The program name is found by taking
1075 * the last component of <literal>argv[0]</literal>.)
1077 * Returns: the name of the program. The returned string belongs
1078 * to GLib and must not be modified or freed.
1081 g_get_prgname (void)
1087 if (g_prgname == NULL)
1089 static gboolean beenhere = FALSE;
1093 gchar *utf8_buf = NULL;
1094 wchar_t buf[MAX_PATH+1];
1097 if (GetModuleFileNameW (GetModuleHandle (NULL),
1098 buf, G_N_ELEMENTS (buf)) > 0)
1099 utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1103 g_prgname = g_path_get_basename (utf8_buf);
1110 G_UNLOCK (g_prgname);
1117 * @prgname: the name of the program.
1119 * Sets the name of the program. This name should <emphasis>not</emphasis>
1120 * be localized, contrast with g_set_application_name(). Note that for
1121 * thread-safety reasons this function can only be called once.
1124 g_set_prgname (const gchar *prgname)
1128 g_prgname = g_strdup (prgname);
1129 G_UNLOCK (g_prgname);
1132 G_LOCK_DEFINE_STATIC (g_application_name);
1133 static gchar *g_application_name = NULL;
1136 * g_get_application_name:
1138 * Gets a human-readable name for the application, as set by
1139 * g_set_application_name(). This name should be localized if
1140 * possible, and is intended for display to the user. Contrast with
1141 * g_get_prgname(), which gets a non-localized name. If
1142 * g_set_application_name() has not been called, returns the result of
1143 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1146 * Return value: human-readable application name. may return %NULL
1151 g_get_application_name (void)
1155 G_LOCK (g_application_name);
1156 retval = g_application_name;
1157 G_UNLOCK (g_application_name);
1160 return g_get_prgname ();
1166 * g_set_application_name:
1167 * @application_name: localized name of the application
1169 * Sets a human-readable name for the application. This name should be
1170 * localized if possible, and is intended for display to the user.
1171 * Contrast with g_set_prgname(), which sets a non-localized name.
1172 * g_set_prgname() will be called automatically by gtk_init(),
1173 * but g_set_application_name() will not.
1175 * Note that for thread safety reasons, this function can only
1178 * The application name will be used in contexts such as error messages,
1179 * or when displaying an application's name in the task list.
1184 g_set_application_name (const gchar *application_name)
1186 gboolean already_set = FALSE;
1188 G_LOCK (g_application_name);
1189 if (g_application_name)
1192 g_application_name = g_strdup (application_name);
1193 G_UNLOCK (g_application_name);
1196 g_warning ("g_set_application_name() called multiple times");
1200 * g_get_user_data_dir:
1202 * Returns a base directory in which to access application data such
1203 * as icons that is customized for a particular user.
1205 * On UNIX platforms this is determined using the mechanisms described in
1206 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1207 * XDG Base Directory Specification</ulink>.
1208 * In this case the directory retrieved will be XDG_DATA_HOME.
1210 * On Windows this is the folder to use for local (as opposed to
1211 * roaming) application data. See documentation for
1212 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1213 * what g_get_user_config_dir() returns.
1215 * Return value: a string owned by GLib that must not be modified
1220 g_get_user_data_dir (void)
1224 G_LOCK (g_utils_global);
1226 if (!g_user_data_dir)
1229 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1231 data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1233 if (data_dir && data_dir[0])
1234 data_dir = g_strdup (data_dir);
1236 if (!data_dir || !data_dir[0])
1241 data_dir = g_build_filename (g_home_dir, ".local",
1244 data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local",
1248 g_user_data_dir = data_dir;
1251 data_dir = g_user_data_dir;
1253 G_UNLOCK (g_utils_global);
1259 g_init_user_config_dir (void)
1263 if (!g_user_config_dir)
1266 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1268 config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1270 if (config_dir && config_dir[0])
1271 config_dir = g_strdup (config_dir);
1273 if (!config_dir || !config_dir[0])
1278 config_dir = g_build_filename (g_home_dir, ".config", NULL);
1280 config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
1283 g_user_config_dir = config_dir;
1288 * g_get_user_config_dir:
1290 * Returns a base directory in which to store user-specific application
1291 * configuration information such as user preferences and settings.
1293 * On UNIX platforms this is determined using the mechanisms described in
1294 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1295 * XDG Base Directory Specification</ulink>.
1296 * In this case the directory retrieved will be XDG_CONFIG_HOME.
1298 * On Windows this is the folder to use for local (as opposed to
1299 * roaming) application data. See documentation for
1300 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1301 * what g_get_user_data_dir() returns.
1303 * Return value: a string owned by GLib that must not be modified
1308 g_get_user_config_dir (void)
1310 G_LOCK (g_utils_global);
1312 g_init_user_config_dir ();
1314 G_UNLOCK (g_utils_global);
1316 return g_user_config_dir;
1320 * g_get_user_cache_dir:
1322 * Returns a base directory in which to store non-essential, cached
1323 * data specific to particular user.
1325 * On UNIX platforms this is determined using the mechanisms described in
1326 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1327 * XDG Base Directory Specification</ulink>.
1328 * In this case the directory retrieved will be XDG_CACHE_HOME.
1330 * On Windows is the directory that serves as a common repository for
1331 * temporary Internet files. A typical path is
1332 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1333 * See documentation for CSIDL_INTERNET_CACHE.
1335 * Return value: a string owned by GLib that must not be modified
1340 g_get_user_cache_dir (void)
1344 G_LOCK (g_utils_global);
1346 if (!g_user_cache_dir)
1349 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1351 cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1353 if (cache_dir && cache_dir[0])
1354 cache_dir = g_strdup (cache_dir);
1356 if (!cache_dir || !cache_dir[0])
1361 cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
1363 cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
1365 g_user_cache_dir = cache_dir;
1368 cache_dir = g_user_cache_dir;
1370 G_UNLOCK (g_utils_global);
1376 * g_get_user_runtime_dir:
1378 * Returns a directory that is unique to the current user on the local
1381 * On UNIX platforms this is determined using the mechanisms described in
1382 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1383 * XDG Base Directory Specification</ulink>. This is the directory
1384 * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
1385 * In the case that this variable is not set, GLib will issue a warning
1386 * message to stderr and return the value of g_get_user_cache_dir().
1388 * On Windows this is the folder to use for local (as opposed to
1389 * roaming) application data. See documentation for
1390 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1391 * what g_get_user_config_dir() returns.
1393 * Returns: a string owned by GLib that must not be modified or freed.
1398 g_get_user_runtime_dir (void)
1401 static const gchar *runtime_dir;
1402 static gsize initialised;
1404 if (g_once_init_enter (&initialised))
1406 runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1408 g_once_init_leave (&initialised, 1);
1414 /* Both fallback for UNIX and the default
1415 * in Windows: use the user cache directory.
1419 return g_get_user_cache_dir ();
1425 find_folder (OSType type)
1427 gchar *filename = NULL;
1430 if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1432 CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1436 CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1440 filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1444 filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1446 CFStringGetCString (path, filename,
1447 CFStringGetLength (path) * 3 + 1,
1448 kCFStringEncodingUTF8);
1462 load_user_special_dirs (void)
1464 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1465 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1466 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1467 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1468 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1469 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1470 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1471 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1474 #endif /* HAVE_CARBON */
1476 #if defined(G_OS_WIN32)
1478 load_user_special_dirs (void)
1480 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1484 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1486 static const GUID FOLDERID_Downloads =
1487 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1488 static const GUID FOLDERID_Public =
1489 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1493 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1494 "SHGetKnownFolderPath");
1496 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1497 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1499 if (p_SHGetKnownFolderPath == NULL)
1501 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1506 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1509 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1510 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1511 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1512 CoTaskMemFree (wcp);
1515 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1518 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1519 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1521 if (p_SHGetKnownFolderPath == NULL)
1524 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1529 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1532 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1533 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1534 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1535 CoTaskMemFree (wcp);
1538 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1541 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1542 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1544 #endif /* G_OS_WIN32 */
1546 static void g_init_user_config_dir (void);
1548 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1550 /* adapted from xdg-user-dir-lookup.c
1552 * Copyright (C) 2007 Red Hat Inc.
1554 * Permission is hereby granted, free of charge, to any person
1555 * obtaining a copy of this software and associated documentation files
1556 * (the "Software"), to deal in the Software without restriction,
1557 * including without limitation the rights to use, copy, modify, merge,
1558 * publish, distribute, sublicense, and/or sell copies of the Software,
1559 * and to permit persons to whom the Software is furnished to do so,
1560 * subject to the following conditions:
1562 * The above copyright notice and this permission notice shall be
1563 * included in all copies or substantial portions of the Software.
1565 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1566 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1567 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1568 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1569 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1570 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1571 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1575 load_user_special_dirs (void)
1582 g_init_user_config_dir ();
1583 config_file = g_build_filename (g_user_config_dir,
1587 if (!g_file_get_contents (config_file, &data, NULL, NULL))
1589 g_free (config_file);
1593 lines = g_strsplit (data, "\n", -1);
1594 n_lines = g_strv_length (lines);
1597 for (i = 0; i < n_lines; i++)
1599 gchar *buffer = lines[i];
1602 gboolean is_relative = FALSE;
1603 GUserDirectory directory;
1605 /* Remove newline at end */
1606 len = strlen (buffer);
1607 if (len > 0 && buffer[len - 1] == '\n')
1608 buffer[len - 1] = 0;
1611 while (*p == ' ' || *p == '\t')
1614 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1616 directory = G_USER_DIRECTORY_DESKTOP;
1617 p += strlen ("XDG_DESKTOP_DIR");
1619 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1621 directory = G_USER_DIRECTORY_DOCUMENTS;
1622 p += strlen ("XDG_DOCUMENTS_DIR");
1624 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1626 directory = G_USER_DIRECTORY_DOWNLOAD;
1627 p += strlen ("XDG_DOWNLOAD_DIR");
1629 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1631 directory = G_USER_DIRECTORY_MUSIC;
1632 p += strlen ("XDG_MUSIC_DIR");
1634 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1636 directory = G_USER_DIRECTORY_PICTURES;
1637 p += strlen ("XDG_PICTURES_DIR");
1639 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1641 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1642 p += strlen ("XDG_PUBLICSHARE_DIR");
1644 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1646 directory = G_USER_DIRECTORY_TEMPLATES;
1647 p += strlen ("XDG_TEMPLATES_DIR");
1649 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1651 directory = G_USER_DIRECTORY_VIDEOS;
1652 p += strlen ("XDG_VIDEOS_DIR");
1657 while (*p == ' ' || *p == '\t')
1664 while (*p == ' ' || *p == '\t')
1671 if (strncmp (p, "$HOME", 5) == 0)
1679 d = strrchr (p, '"');
1686 /* remove trailing slashes */
1688 if (d[len - 1] == '/')
1694 g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
1697 g_user_special_dirs[directory] = g_strdup (d);
1701 g_free (config_file);
1704 #endif /* G_OS_UNIX && !HAVE_CARBON */
1708 * g_reload_user_special_dirs_cache:
1710 * Resets the cache used for g_get_user_special_dir(), so
1711 * that the latest on-disk version is used. Call this only
1712 * if you just changed the data on disk yourself.
1714 * Due to threadsafety issues this may cause leaking of strings
1715 * that were previously returned from g_get_user_special_dir()
1716 * that can't be freed. We ensure to only leak the data for
1717 * the directories that actually changed value though.
1722 g_reload_user_special_dirs_cache (void)
1726 G_LOCK (g_utils_global);
1728 if (g_user_special_dirs != NULL)
1730 /* save a copy of the pointer, to check if some memory can be preserved */
1731 char **old_g_user_special_dirs = g_user_special_dirs;
1734 /* recreate and reload our cache */
1735 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1736 load_user_special_dirs ();
1738 /* only leak changed directories */
1739 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1741 old_val = old_g_user_special_dirs[i];
1742 if (g_user_special_dirs[i] == NULL)
1744 g_user_special_dirs[i] = old_val;
1746 else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1749 g_free (g_user_special_dirs[i]);
1750 g_user_special_dirs[i] = old_val;
1756 /* free the old array */
1757 g_free (old_g_user_special_dirs);
1760 G_UNLOCK (g_utils_global);
1764 * g_get_user_special_dir:
1765 * @directory: the logical id of special directory
1767 * Returns the full path of a special directory using its logical id.
1769 * On Unix this is done using the XDG special user directories.
1770 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1771 * falls back to <filename>$HOME/Desktop</filename> when XDG special
1772 * user directories have not been set up.
1774 * Depending on the platform, the user might be able to change the path
1775 * of the special directory without requiring the session to restart; GLib
1776 * will not reflect any change once the special directories are loaded.
1778 * Return value: the path to the specified special directory, or %NULL
1779 * if the logical id was not found. The returned string is owned by
1780 * GLib and should not be modified or freed.
1785 g_get_user_special_dir (GUserDirectory directory)
1787 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1788 directory < G_USER_N_DIRECTORIES, NULL);
1790 G_LOCK (g_utils_global);
1792 if (G_UNLIKELY (g_user_special_dirs == NULL))
1794 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1796 load_user_special_dirs ();
1798 /* Special-case desktop for historical compatibility */
1799 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1803 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
1804 g_build_filename (g_home_dir, "Desktop", NULL);
1808 G_UNLOCK (g_utils_global);
1810 return g_user_special_dirs[directory];
1815 #undef g_get_system_data_dirs
1818 get_module_for_address (gconstpointer address)
1820 /* Holds the g_utils_global lock */
1822 static gboolean beenhere = FALSE;
1823 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1824 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1825 HMODULE hmodule = NULL;
1832 p_GetModuleHandleExA =
1833 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1834 "GetModuleHandleExA");
1838 if (p_GetModuleHandleExA == NULL ||
1839 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1840 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1843 MEMORY_BASIC_INFORMATION mbi;
1844 VirtualQuery (address, &mbi, sizeof (mbi));
1845 hmodule = (HMODULE) mbi.AllocationBase;
1852 get_module_share_dir (gconstpointer address)
1858 hmodule = get_module_for_address (address);
1859 if (hmodule == NULL)
1862 filename = g_win32_get_package_installation_directory_of_module (hmodule);
1863 retval = g_build_filename (filename, "share", NULL);
1869 const gchar * const *
1870 g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
1874 static GHashTable *per_module_data_dirs = NULL;
1879 if (address_of_function)
1881 G_LOCK (g_utils_global);
1882 hmodule = get_module_for_address (address_of_function);
1883 if (hmodule != NULL)
1885 if (per_module_data_dirs == NULL)
1886 per_module_data_dirs = g_hash_table_new (NULL, NULL);
1889 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1893 G_UNLOCK (g_utils_global);
1894 return (const gchar * const *) retval;
1900 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1902 /* Documents and Settings\All Users\Application Data */
1903 p = get_special_folder (CSIDL_COMMON_APPDATA);
1905 g_array_append_val (data_dirs, p);
1907 /* Documents and Settings\All Users\Documents */
1908 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1910 g_array_append_val (data_dirs, p);
1912 /* Using the above subfolders of Documents and Settings perhaps
1913 * makes sense from a Windows perspective.
1915 * But looking at the actual use cases of this function in GTK+
1916 * and GNOME software, what we really want is the "share"
1917 * subdirectory of the installation directory for the package
1918 * our caller is a part of.
1920 * The address_of_function parameter, if non-NULL, points to a
1921 * function in the calling module. Use that to determine that
1922 * module's installation folder, and use its "share" subfolder.
1924 * Additionally, also use the "share" subfolder of the installation
1925 * locations of GLib and the .exe file being run.
1927 * To guard against none of the above being what is really wanted,
1928 * callers of this function should have Win32-specific code to look
1929 * up their installation folder themselves, and handle a subfolder
1930 * "share" of it in the same way as the folders returned from this
1934 p = get_module_share_dir (address_of_function);
1936 g_array_append_val (data_dirs, p);
1938 if (glib_dll != NULL)
1940 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1941 p = g_build_filename (glib_root, "share", NULL);
1943 g_array_append_val (data_dirs, p);
1947 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1948 p = g_build_filename (exe_root, "share", NULL);
1950 g_array_append_val (data_dirs, p);
1953 retval = (gchar **) g_array_free (data_dirs, FALSE);
1955 if (address_of_function)
1957 if (hmodule != NULL)
1958 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1959 G_UNLOCK (g_utils_global);
1962 return (const gchar * const *) retval;
1968 * g_get_system_data_dirs:
1970 * Returns an ordered list of base directories in which to access
1971 * system-wide application data.
1973 * On UNIX platforms this is determined using the mechanisms described in
1974 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1975 * XDG Base Directory Specification</ulink>
1976 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1978 * On Windows the first elements in the list are the Application Data
1979 * and Documents folders for All Users. (These can be determined only
1980 * on Windows 2000 or later and are not present in the list on other
1981 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1982 * CSIDL_COMMON_DOCUMENTS.
1984 * Then follows the "share" subfolder in the installation folder for
1985 * the package containing the DLL that calls this function, if it can
1988 * Finally the list contains the "share" subfolder in the installation
1989 * folder for GLib, and in the installation folder for the package the
1990 * application's .exe file belongs to.
1992 * The installation folders above are determined by looking up the
1993 * folder where the module (DLL or EXE) in question is located. If the
1994 * folder's name is "bin", its parent is used, otherwise the folder
1997 * Note that on Windows the returned list can vary depending on where
1998 * this function is called.
2000 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2001 * not be modified or freed.
2004 const gchar * const *
2005 g_get_system_data_dirs (void)
2007 gchar **data_dir_vector;
2009 G_LOCK (g_utils_global);
2011 if (!g_system_data_dirs)
2014 data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2016 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2018 if (!data_dirs || !data_dirs[0])
2019 data_dirs = "/usr/local/share/:/usr/share/";
2021 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2024 g_system_data_dirs = data_dir_vector;
2027 data_dir_vector = g_system_data_dirs;
2029 G_UNLOCK (g_utils_global);
2031 return (const gchar * const *) data_dir_vector;
2035 * g_get_system_config_dirs:
2037 * Returns an ordered list of base directories in which to access
2038 * system-wide configuration information.
2040 * On UNIX platforms this is determined using the mechanisms described in
2041 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2042 * XDG Base Directory Specification</ulink>.
2043 * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2045 * On Windows is the directory that contains application data for all users.
2046 * A typical path is C:\Documents and Settings\All Users\Application Data.
2047 * This folder is used for application data that is not user specific.
2048 * For example, an application can store a spell-check dictionary, a database
2049 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2050 * This information will not roam and is available to anyone using the computer.
2052 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2053 * not be modified or freed.
2056 const gchar * const *
2057 g_get_system_config_dirs (void)
2059 gchar *conf_dirs, **conf_dir_vector;
2061 G_LOCK (g_utils_global);
2063 if (!g_system_config_dirs)
2066 conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2069 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2074 /* Return empty list */
2075 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2078 conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2080 if (!conf_dirs || !conf_dirs[0])
2081 conf_dirs = "/etc/xdg";
2083 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2086 g_system_config_dirs = conf_dir_vector;
2089 conf_dir_vector = g_system_config_dirs;
2090 G_UNLOCK (g_utils_global);
2092 return (const gchar * const *) conf_dir_vector;
2096 * g_nullify_pointer:
2097 * @nullify_location: the memory address of the pointer.
2099 * Set the pointer at the specified location to %NULL.
2102 g_nullify_pointer (gpointer *nullify_location)
2104 g_return_if_fail (nullify_location != NULL);
2106 *nullify_location = NULL;
2109 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2110 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2111 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2112 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2113 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2114 #define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2116 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2117 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2118 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2119 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2120 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2121 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2125 * @size: a size in bytes
2127 * Formats a size (for example the size of a file) into a human readable
2128 * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
2129 * and are displayed rounded to the nearest tenth. E.g. the file size
2130 * 3292528 bytes will be converted into the string "3.2 MB".
2132 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2134 * This string should be freed with g_free() when not needed any longer.
2136 * See g_format_size_full() for more options about how the size might be
2139 * Returns: a newly-allocated formatted string containing a human readable
2145 g_format_size (guint64 size)
2147 return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2152 * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2153 * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2154 * of the returned string. For example, "45.6 kB (45,612 bytes)".
2155 * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2156 * suffixes. IEC units should only be used for reporting things with
2157 * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2158 * Network and storage sizes should be reported in the normal SI units.
2160 * Flags to modify the format of the string returned by g_format_size_full().
2164 * g_format_size_full:
2165 * @size: a size in bytes
2166 * @flags: #GFormatSizeFlags to modify the output
2170 * This function is similar to g_format_size() but allows for flags
2171 * that modify the output. See #GFormatSizeFlags.
2173 * Returns: a newly-allocated formatted string containing a human
2174 * readable file size
2179 g_format_size_full (guint64 size,
2180 GFormatSizeFlags flags)
2184 string = g_string_new (NULL);
2186 if (flags & G_FORMAT_SIZE_IEC_UNITS)
2188 if (size < KIBIBYTE_FACTOR)
2190 g_string_printf (string,
2191 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2193 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2196 else if (size < MEBIBYTE_FACTOR)
2197 g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2198 else if (size < GIBIBYTE_FACTOR)
2199 g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2201 else if (size < TEBIBYTE_FACTOR)
2202 g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2204 else if (size < PEBIBYTE_FACTOR)
2205 g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2207 else if (size < EXBIBYTE_FACTOR)
2208 g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2211 g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2215 if (size < KILOBYTE_FACTOR)
2217 g_string_printf (string,
2218 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2220 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2223 else if (size < MEGABYTE_FACTOR)
2224 g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2226 else if (size < GIGABYTE_FACTOR)
2227 g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2229 else if (size < TERABYTE_FACTOR)
2230 g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2231 else if (size < PETABYTE_FACTOR)
2232 g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2234 else if (size < EXABYTE_FACTOR)
2235 g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2238 g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2241 if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2243 /* First problem: we need to use the number of bytes to decide on
2244 * the plural form that is used for display, but the number of
2245 * bytes potentially exceeds the size of a guint (which is what
2246 * ngettext() takes).
2248 * From a pragmatic standpoint, it seems that all known languages
2249 * base plural forms on one or both of the following:
2251 * - the lowest digits of the number
2253 * - if the number if greater than some small value
2255 * Here's how we fake it: Draw an arbitrary line at one thousand.
2256 * If the number is below that, then fine. If it is above it,
2257 * then we take the modulus of the number by one thousand (in
2258 * order to keep the lowest digits) and add one thousand to that
2259 * (in order to ensure that 1001 is not treated the same as 1).
2261 guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2263 /* Second problem: we need to translate the string "%u byte" and
2264 * "%u bytes" for pluralisation, but the correct number format to
2265 * use for a gsize is different depending on which architecture
2268 * Solution: format the number separately and use "%s bytes" on
2271 const gchar *translated_format;
2272 gchar *formatted_number;
2274 /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2275 translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2276 /* XXX: Windows doesn't support the "'" format modifier, so we
2277 * must not use it there. Instead, just display the number
2278 * without separation. Bug #655336 is open until a solution is
2282 formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2284 formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2287 g_string_append (string, " (");
2288 g_string_append_printf (string, translated_format, formatted_number);
2289 g_free (formatted_number);
2290 g_string_append (string, ")");
2293 return g_string_free (string, FALSE);
2297 * g_format_size_for_display:
2298 * @size: a size in bytes
2300 * Formats a size (for example the size of a file) into a human
2301 * readable string. Sizes are rounded to the nearest size prefix
2302 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2303 * E.g. the file size 3292528 bytes will be converted into the
2306 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2308 * This string should be freed with g_free() when not needed any longer.
2310 * Returns: a newly-allocated formatted string containing a human
2311 * readable file size
2315 * Deprecated:2.30: This function is broken due to its use of SI
2316 * suffixes to denote IEC units. Use g_format_size() instead.
2319 g_format_size_for_display (goffset size)
2321 if (size < (goffset) KIBIBYTE_FACTOR)
2322 return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2325 gdouble displayed_size;
2327 if (size < (goffset) MEBIBYTE_FACTOR)
2329 displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2330 /* Translators: this is from the deprecated function g_format_size_for_display() which uses 'KB' to
2331 * mean 1024 bytes. I am aware that 'KB' is not correct, but it has been preserved for reasons of
2332 * compatibility. Users will not see this string unless a program is using this deprecated function.
2333 * Please translate as literally as possible.
2335 return g_strdup_printf (_("%.1f KB"), displayed_size);
2337 else if (size < (goffset) GIBIBYTE_FACTOR)
2339 displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2340 return g_strdup_printf (_("%.1f MB"), displayed_size);
2342 else if (size < (goffset) TEBIBYTE_FACTOR)
2344 displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2345 return g_strdup_printf (_("%.1f GB"), displayed_size);
2347 else if (size < (goffset) PEBIBYTE_FACTOR)
2349 displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2350 return g_strdup_printf (_("%.1f TB"), displayed_size);
2352 else if (size < (goffset) EXBIBYTE_FACTOR)
2354 displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2355 return g_strdup_printf (_("%.1f PB"), displayed_size);
2359 displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2360 return g_strdup_printf (_("%.1f EB"), displayed_size);
2365 #if defined (G_OS_WIN32) && !defined (_WIN64)
2367 /* Binary compatibility versions. Not for newly compiled code. */
2369 #undef g_find_program_in_path
2372 g_find_program_in_path (const gchar *program)
2374 gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
2375 gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
2378 g_free (utf8_program);
2379 if (utf8_retval == NULL)
2381 retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
2382 g_free (utf8_retval);
2387 #undef g_get_user_name
2390 g_get_user_name (void)
2392 g_get_any_init_locked ();
2393 return g_user_name_cp;
2396 #undef g_get_real_name
2399 g_get_real_name (void)
2401 g_get_any_init_locked ();
2402 return g_real_name_cp;
2405 #undef g_get_home_dir
2408 g_get_home_dir (void)
2410 g_get_any_init_locked ();
2411 return g_home_dir_cp;
2414 #undef g_get_tmp_dir
2417 g_get_tmp_dir (void)
2419 g_get_any_init_locked ();
2420 return g_tmp_dir_cp;
2427 * Returns %TRUE if the current process was executed as setuid (or an
2428 * equivalent __libc_enable_secure is available). See:
2429 * http://osdir.com/ml/linux.lfs.hardened/2007-04/msg00032.html
2431 G_GNUC_INTERNAL gboolean
2432 g_check_setuid (void)
2434 /* TODO: get __libc_enable_secure exported from glibc.
2435 * See http://www.openwall.com/lists/owl-dev/2012/08/14/1
2437 #if 0 && defined(HAVE_LIBC_ENABLE_SECURE)
2439 /* See glibc/include/unistd.h */
2440 extern int __libc_enable_secure;
2441 return __libc_enable_secure;
2443 #elif defined(HAVE_ISSETUGID)
2444 /* BSD: http://www.freebsd.org/cgi/man.cgi?query=issetugid&sektion=2 */
2445 return issetugid ();
2446 #elif defined(G_OS_UNIX)
2447 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
2448 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
2450 static gsize check_setuid_initialised;
2451 static gboolean is_setuid;
2453 if (g_once_init_enter (&check_setuid_initialised))
2455 #ifdef HAVE_GETRESUID
2456 /* These aren't in the header files, so we prototype them here.
2458 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
2459 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
2461 if (getresuid (&ruid, &euid, &suid) != 0 ||
2462 getresgid (&rgid, &egid, &sgid) != 0)
2463 #endif /* HAVE_GETRESUID */
2465 suid = ruid = getuid ();
2466 sgid = rgid = getgid ();
2471 is_setuid = (ruid != euid || ruid != suid ||
2472 rgid != egid || rgid != sgid);
2474 g_once_init_leave (&check_setuid_initialised, 1);