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"
64 #include "gfileutils.h"
68 #include "gtestutils.h"
70 #include "gstrfuncs.h"
74 #ifdef G_PLATFORM_WIN32
82 * @title: Miscellaneous Utility Functions
83 * @short_description: a selection of portable utility functions
85 * These are portable utility functions.
88 #ifdef G_PLATFORM_WIN32
90 # ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
91 # define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
92 # define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
94 # include <lmcons.h> /* For UNLEN */
95 #endif /* G_PLATFORM_WIN32 */
100 /* older SDK (e.g. msvc 5.0) does not have these*/
101 # ifndef CSIDL_MYMUSIC
102 # define CSIDL_MYMUSIC 13
104 # ifndef CSIDL_MYVIDEO
105 # define CSIDL_MYVIDEO 14
107 # ifndef CSIDL_INTERNET_CACHE
108 # define CSIDL_INTERNET_CACHE 32
110 # ifndef CSIDL_COMMON_APPDATA
111 # define CSIDL_COMMON_APPDATA 35
113 # ifndef CSIDL_MYPICTURES
114 # define CSIDL_MYPICTURES 0x27
116 # ifndef CSIDL_COMMON_DOCUMENTS
117 # define CSIDL_COMMON_DOCUMENTS 46
119 # ifndef CSIDL_PROFILE
120 # define CSIDL_PROFILE 40
122 # include <process.h>
126 #include <CoreServices/CoreServices.h>
130 #include <langinfo.h>
133 #ifdef G_PLATFORM_WIN32
136 _glib_get_dll_directory (void)
140 wchar_t wc_fn[MAX_PATH];
143 if (glib_dll == NULL)
147 /* This code is different from that in
148 * g_win32_get_package_installation_directory_of_module() in that
149 * here we return the actual folder where the GLib DLL is. We don't
150 * do the check for it being in a "bin" or "lib" subfolder and then
151 * returning the parent of that.
153 * In a statically built GLib, glib_dll will be NULL and we will
154 * thus look up the application's .exe file's location.
156 if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
159 retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
161 p = strrchr (retval, G_DIR_SEPARATOR);
174 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
177 * @dest: the destination address to copy the bytes to.
178 * @src: the source address to copy the bytes from.
179 * @len: the number of bytes to copy.
181 * Copies a block of memory @len bytes long, from @src to @dest.
182 * The source and destination areas may overlap.
184 * In order to use this function, you must include
185 * <filename>string.h</filename> yourself, because this macro will
186 * typically simply resolve to memmove() and GLib does not include
187 * <filename>string.h</filename> for you.
190 g_memmove (gpointer dest,
194 gchar* destptr = dest;
195 const gchar* srcptr = src;
196 if (src + len < dest || dest + len < src)
198 bcopy (src, dest, len);
201 else if (dest <= src)
204 *(destptr++) = *(srcptr++);
211 *(--destptr) = *(--srcptr);
214 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
222 * @func: (scope async): the function to call on normal program termination.
224 * Specifies a function to be called at normal program termination.
226 * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
227 * macro that maps to a call to the atexit() function in the C
228 * library. This means that in case the code that calls g_atexit(),
229 * i.e. atexit(), is in a DLL, the function will be called when the
230 * DLL is detached from the program. This typically makes more sense
231 * than that the function is called when the GLib DLL is detached,
232 * which happened earlier when g_atexit() was a function in the GLib
235 * The behaviour of atexit() in the context of dynamically loaded
236 * modules is not formally specified and varies wildly.
238 * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
239 * loaded module which is unloaded before the program terminates might
240 * well cause a crash at program exit.
242 * Some POSIX systems implement atexit() like Windows, and have each
243 * dynamically loaded module maintain an own atexit chain that is
244 * called when the module is unloaded.
246 * On other POSIX systems, before a dynamically loaded module is
247 * unloaded, the registered atexit functions (if any) residing in that
248 * module are called, regardless where the code that registered them
249 * resided. This is presumably the most robust approach.
251 * As can be seen from the above, for portability it's best to avoid
252 * calling g_atexit() (or atexit()) except in the main executable of a
255 * Deprecated:2.32: It is best to avoid g_atexit().
258 g_atexit (GVoidFunc func)
261 const gchar *error = NULL;
263 /* keep this in sync with glib.h */
265 #ifdef G_NATIVE_ATEXIT
266 result = ATEXIT (func);
268 error = g_strerror (errno);
269 #elif defined (HAVE_ATEXIT)
270 # ifdef NeXT /* @#%@! NeXTStep */
271 result = !atexit ((void (*)(void)) func);
273 error = g_strerror (errno);
275 result = atexit ((void (*)(void)) func);
277 error = g_strerror (errno);
279 #elif defined (HAVE_ON_EXIT)
280 result = on_exit ((void (*)(int, void *)) func, NULL);
282 error = g_strerror (errno);
285 error = "no implementation";
286 #endif /* G_NATIVE_ATEXIT */
289 g_error ("Could not register atexit() function: %s", error);
292 /* Based on execvp() from GNU Libc.
293 * Some of this code is cut-and-pasted into gspawn.c
297 my_strchrnul (const gchar *str,
300 gchar *p = (gchar*)str;
301 while (*p && (*p != c))
309 static gchar *inner_find_program_in_path (const gchar *program);
312 g_find_program_in_path (const gchar *program)
314 const gchar *last_dot = strrchr (program, '.');
316 if (last_dot == NULL ||
317 strchr (last_dot, '\\') != NULL ||
318 strchr (last_dot, '/') != NULL)
320 const gint program_length = strlen (program);
321 gchar *pathext = g_build_path (";",
322 ".exe;.cmd;.bat;.com",
323 g_getenv ("PATHEXT"),
326 gchar *decorated_program;
332 gchar *q = my_strchrnul (p, ';');
334 decorated_program = g_malloc (program_length + (q-p) + 1);
335 memcpy (decorated_program, program, program_length);
336 memcpy (decorated_program+program_length, p, q-p);
337 decorated_program [program_length + (q-p)] = '\0';
339 retval = inner_find_program_in_path (decorated_program);
340 g_free (decorated_program);
348 } while (*p++ != '\0');
353 return inner_find_program_in_path (program);
359 * g_find_program_in_path:
360 * @program: a program name in the GLib file name encoding
362 * Locates the first executable named @program in the user's path, in the
363 * same way that execvp() would locate it. Returns an allocated string
364 * with the absolute path name, or %NULL if the program is not found in
365 * the path. If @program is already an absolute path, returns a copy of
366 * @program if @program exists and is executable, and %NULL otherwise.
368 * On Windows, if @program does not have a file type suffix, tries
369 * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
370 * the <envar>PATHEXT</envar> environment variable.
372 * On Windows, it looks for the file in the same way as CreateProcess()
373 * would. This means first in the directory where the executing
374 * program was loaded from, then in the current directory, then in the
375 * Windows 32-bit system directory, then in the Windows directory, and
376 * finally in the directories in the <envar>PATH</envar> environment
377 * variable. If the program is found, the return value contains the
378 * full name including the type suffix.
380 * Return value: a newly-allocated string with the absolute path, or %NULL
384 inner_find_program_in_path (const gchar *program)
387 g_find_program_in_path (const gchar *program)
390 const gchar *path, *p;
391 gchar *name, *freeme;
393 const gchar *path_copy;
394 gchar *filename = NULL, *appdir = NULL;
395 gchar *sysdir = NULL, *windir = NULL;
397 wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
403 g_return_val_if_fail (program != NULL, NULL);
405 /* If it is an absolute path, or a relative path including subdirectories,
406 * don't look in PATH.
408 if (g_path_is_absolute (program)
409 || strchr (program, G_DIR_SEPARATOR) != NULL
411 || strchr (program, '/') != NULL
415 if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
416 !g_file_test (program, G_FILE_TEST_IS_DIR))
417 return g_strdup (program);
422 path = g_getenv ("PATH");
423 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
426 /* There is no `PATH' in the environment. The default
427 * search path in GNU libc is the current directory followed by
428 * the path `confstr' returns for `_CS_PATH'.
431 /* In GLib we put . last, for security, and don't use the
432 * unportable confstr(); UNIX98 does not actually specify
433 * what to search if PATH is unset. POSIX may, dunno.
436 path = "/bin:/usr/bin:.";
439 n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
440 if (n > 0 && n < MAXPATHLEN)
441 filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
443 n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
444 if (n > 0 && n < MAXPATHLEN)
445 sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
447 n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
448 if (n > 0 && n < MAXPATHLEN)
449 windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
453 appdir = g_path_get_dirname (filename);
457 path = g_strdup (path);
461 const gchar *tem = path;
462 path = g_strconcat (windir, ";", path, NULL);
463 g_free ((gchar *) tem);
469 const gchar *tem = path;
470 path = g_strconcat (sysdir, ";", path, NULL);
471 g_free ((gchar *) tem);
476 const gchar *tem = path;
477 path = g_strconcat (".;", path, NULL);
478 g_free ((gchar *) tem);
483 const gchar *tem = path;
484 path = g_strconcat (appdir, ";", path, NULL);
485 g_free ((gchar *) tem);
492 len = strlen (program) + 1;
493 pathlen = strlen (path);
494 freeme = name = g_malloc (pathlen + len + 1);
496 /* Copy the file name at the top, including '\0' */
497 memcpy (name + pathlen + 1, program, len);
498 name = name + pathlen;
499 /* And add the slash before the filename */
500 *name = G_DIR_SEPARATOR;
508 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
511 /* Two adjacent colons, or a colon at the beginning or the end
512 * of `PATH' means to search the current directory.
516 startp = memcpy (name - (p - path), path, p - path);
518 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
519 !g_file_test (startp, G_FILE_TEST_IS_DIR))
522 ret = g_strdup (startp);
525 g_free ((gchar *) path_copy);
530 while (*p++ != '\0');
534 g_free ((gchar *) path_copy);
542 * @mask: a #gulong containing flags
543 * @nth_bit: the index of the bit to start the search from
545 * Find the position of the first bit set in @mask, searching
546 * from (but not including) @nth_bit upwards. Bits are numbered
547 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
548 * usually). To start searching from the 0th bit, set @nth_bit to -1.
550 * Returns: the index of the first bit set which is higher than @nth_bit
555 * @mask: a #gulong containing flags
556 * @nth_bit: the index of the bit to start the search from
558 * Find the position of the first bit set in @mask, searching
559 * from (but not including) @nth_bit downwards. Bits are numbered
560 * from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
561 * usually). To start searching from the last bit, set @nth_bit to
562 * -1 or GLIB_SIZEOF_LONG * 8.
564 * Returns: the index of the first bit set which is lower than @nth_bit
571 * Gets the number of bits used to hold @number,
572 * e.g. if @number is 4, 3 bits are needed.
574 * Returns: the number of bits used to hold @number
577 G_LOCK_DEFINE_STATIC (g_utils_global);
579 static gchar *g_tmp_dir = NULL;
580 static gchar *g_user_name = NULL;
581 static gchar *g_real_name = NULL;
582 static gchar *g_home_dir = NULL;
583 static gchar *g_host_name = NULL;
586 /* System codepage versions of the above, kept at file level so that they,
587 * too, are produced only once.
589 static gchar *g_tmp_dir_cp = NULL;
590 static gchar *g_user_name_cp = NULL;
591 static gchar *g_real_name_cp = NULL;
592 static gchar *g_home_dir_cp = NULL;
595 static gchar *g_user_data_dir = NULL;
596 static gchar **g_system_data_dirs = NULL;
597 static gchar *g_user_cache_dir = NULL;
598 static gchar *g_user_config_dir = NULL;
599 static gchar **g_system_config_dirs = NULL;
601 static gchar **g_user_special_dirs = NULL;
603 /* fifteen minutes of fame for everybody */
604 #define G_USER_DIRS_EXPIRE 15 * 60
609 get_special_folder (int csidl)
611 wchar_t path[MAX_PATH+1];
613 LPITEMIDLIST pidl = NULL;
615 gchar *retval = NULL;
617 hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
620 b = SHGetPathFromIDListW (pidl, path);
622 retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
623 CoTaskMemFree (pidl);
629 get_windows_directory_root (void)
631 wchar_t wwindowsdir[MAX_PATH];
633 if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
635 /* Usually X:\Windows, but in terminal server environments
636 * might be an UNC path, AFAIK.
638 char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
641 if (windowsdir == NULL)
642 return g_strdup ("C:\\");
644 p = (char *) g_path_skip_root (windowsdir);
645 if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
651 return g_strdup ("C:\\");
656 /* HOLDS: g_utils_global_lock */
658 g_get_any_init_do (void)
662 g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
664 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
667 g_tmp_dir = g_strdup (g_getenv ("TMP"));
670 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
673 g_tmp_dir = g_strdup (g_getenv ("TEMP"));
677 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
680 g_tmp_dir = get_windows_directory_root ();
685 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
689 g_tmp_dir = g_strdup (P_tmpdir);
690 k = strlen (g_tmp_dir);
691 if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
692 g_tmp_dir[k - 1] = '\0';
696 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
699 g_tmp_dir = g_strdup ("/tmp");
701 #endif /* !G_OS_WIN32 */
704 /* We check $HOME first for Win32, though it is a last resort for Unix
705 * where we prefer the results of getpwuid().
707 g_home_dir = g_strdup (g_getenv ("HOME"));
709 /* Only believe HOME if it is an absolute path and exists */
712 if (!(g_path_is_absolute (g_home_dir) &&
713 g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
720 /* In case HOME is Unix-style (it happens), convert it to
726 while ((p = strchr (g_home_dir, '/')) != NULL)
732 /* USERPROFILE is probably the closest equivalent to $HOME? */
733 if (g_getenv ("USERPROFILE") != NULL)
734 g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
738 g_home_dir = get_special_folder (CSIDL_PROFILE);
741 g_home_dir = get_windows_directory_root ();
742 #endif /* G_OS_WIN32 */
746 struct passwd *pw = NULL;
747 gpointer buffer = NULL;
751 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
753 # ifdef _SC_GETPW_R_SIZE_MAX
754 /* This reurns the maximum length */
755 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
759 # else /* _SC_GETPW_R_SIZE_MAX */
761 # endif /* _SC_GETPW_R_SIZE_MAX */
763 logname = (gchar *) g_getenv ("LOGNAME");
768 /* we allocate 6 extra bytes to work around a bug in
769 * Mac OS < 10.3. See #156446
771 buffer = g_malloc (bufsize + 6);
774 # ifdef HAVE_POSIX_GETPWUID_R
776 error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
777 if (!pw || (pw->pw_uid != getuid ())) {
778 /* LOGNAME is lying, fall back to looking up the uid */
779 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
782 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
784 error = error < 0 ? errno : error;
785 # else /* HAVE_NONPOSIX_GETPWUID_R */
786 /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
787 # if defined(_AIX) || defined(__hpux)
788 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
789 pw = error == 0 ? &pwd : NULL;
792 pw = getpwnam_r (logname, &pwd, buffer, bufsize);
793 if (!pw || (pw->pw_uid != getuid ())) {
794 /* LOGNAME is lying, fall back to looking up the uid */
795 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
798 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
800 error = pw ? 0 : errno;
802 # endif /* HAVE_NONPOSIX_GETPWUID_R */
806 /* we bail out prematurely if the user id can't be found
807 * (should be pretty rare case actually), or if the buffer
808 * should be sufficiently big and lookups are still not
811 if (error == 0 || error == ENOENT)
813 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
817 if (bufsize > 32 * 1024)
819 g_warning ("getpwuid_r(): failed due to: %s.",
828 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
833 pw = getpwuid (getuid ());
838 g_user_name = g_strdup (pw->pw_name);
840 if (pw->pw_gecos && *pw->pw_gecos != '\0')
842 gchar **gecos_fields;
845 /* split the gecos field and substitute '&' */
846 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
847 name_parts = g_strsplit (gecos_fields[0], "&", 0);
848 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
849 g_real_name = g_strjoinv (pw->pw_name, name_parts);
850 g_strfreev (gecos_fields);
851 g_strfreev (name_parts);
855 g_home_dir = g_strdup (pw->pw_dir);
860 #else /* !HAVE_PWD_H */
865 wchar_t buffer[UNLEN+1];
867 if (GetUserNameW (buffer, (LPDWORD) &len))
869 g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
870 g_real_name = g_strdup (g_user_name);
873 #endif /* G_OS_WIN32 */
875 #endif /* !HAVE_PWD_H */
879 g_home_dir = g_strdup (g_getenv ("HOME"));
883 /* change '\\' in %HOME% to '/' */
884 g_strdelimit (g_home_dir, "\\",'/');
887 g_user_name = g_strdup ("somebody");
889 g_real_name = g_strdup ("Unknown");
893 gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
895 DWORD size = sizeof (hostname);
896 gboolean hostname_fail = (!GetComputerName (hostname, &size));
898 g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
902 g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
903 g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
904 g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
907 g_tmp_dir_cp = g_strdup ("\\");
909 g_user_name_cp = g_strdup ("somebody");
911 g_real_name_cp = g_strdup ("Unknown");
913 /* home_dir might be NULL, unlike tmp_dir, user_name and
917 g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
919 g_home_dir_cp = NULL;
920 #endif /* G_OS_WIN32 */
924 g_get_any_init (void)
927 g_get_any_init_do ();
931 g_get_any_init_locked (void)
933 G_LOCK (g_utils_global);
935 G_UNLOCK (g_utils_global);
942 * Gets the user name of the current user. The encoding of the returned
943 * string is system-defined. On UNIX, it might be the preferred file name
944 * encoding, or something else, and there is no guarantee that it is even
945 * consistent on a machine. On Windows, it is always UTF-8.
947 * Returns: the user name of the current user.
950 g_get_user_name (void)
952 g_get_any_init_locked ();
959 * Gets the real name of the user. This usually comes from the user's entry
960 * in the <filename>passwd</filename> file. The encoding of the returned
961 * string is system-defined. (On Windows, it is, however, always UTF-8.)
962 * If the real user name cannot be determined, the string "Unknown" is
965 * Returns: the user's real name.
968 g_get_real_name (void)
970 g_get_any_init_locked ();
977 * Gets the current user's home directory as defined in the
980 * Note that in contrast to traditional UNIX tools, this function
981 * prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
982 * environment variable.
984 * One of the reasons for this decision is that applications in many
985 * cases need special handling to deal with the case where
986 * <envar>HOME</envar> is
988 * <member>Not owned by the user</member>
989 * <member>Not writeable</member>
990 * <member>Not even readable</member>
992 * Since applications are in general <emphasis>not</emphasis> written
993 * to deal with these situations it was considered better to make
994 * g_get_home_dir() not pay attention to <envar>HOME</envar> and to
995 * return the real home directory for the user. If applications
996 * want to pay attention to <envar>HOME</envar>, they can do:
998 * const char *homedir = g_getenv ("HOME");
1000 * homedir = g_get_home_dir (<!-- -->);
1003 * Returns: the current user's home directory
1006 g_get_home_dir (void)
1008 g_get_any_init_locked ();
1015 * Gets the directory to use for temporary files. This is found from
1016 * inspecting the environment variables <envar>TMPDIR</envar>,
1017 * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
1018 * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
1019 * The encoding of the returned string is system-defined. On Windows,
1020 * it is always UTF-8. The return value is never %NULL or the empty string.
1022 * Returns: the directory to use for temporary files.
1025 g_get_tmp_dir (void)
1027 g_get_any_init_locked ();
1034 * Return a name for the machine.
1036 * The returned name is not necessarily a fully-qualified domain name,
1037 * or even present in DNS or some other name service at all. It need
1038 * not even be unique on your local network or site, but usually it
1039 * is. Callers should not rely on the return value having any specific
1040 * properties like uniqueness for security purposes. Even if the name
1041 * of the machine is changed while an application is running, the
1042 * return value from this function does not change. The returned
1043 * string is owned by GLib and should not be modified or freed. If no
1044 * name can be determined, a default fixed string "localhost" is
1047 * Returns: the host name of the machine.
1052 g_get_host_name (void)
1054 g_get_any_init_locked ();
1058 G_LOCK_DEFINE_STATIC (g_prgname);
1059 static gchar *g_prgname = NULL;
1064 * Gets the name of the program. This name should <emphasis>not</emphasis>
1065 * be localized, contrast with g_get_application_name().
1066 * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1067 * which is called by gtk_init(). The program name is found by taking
1068 * the last component of <literal>argv[0]</literal>.)
1070 * Returns: the name of the program. The returned string belongs
1071 * to GLib and must not be modified or freed.
1074 g_get_prgname (void)
1080 if (g_prgname == NULL)
1082 static gboolean beenhere = FALSE;
1086 gchar *utf8_buf = NULL;
1087 wchar_t buf[MAX_PATH+1];
1090 if (GetModuleFileNameW (GetModuleHandle (NULL),
1091 buf, G_N_ELEMENTS (buf)) > 0)
1092 utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1096 g_prgname = g_path_get_basename (utf8_buf);
1103 G_UNLOCK (g_prgname);
1110 * @prgname: the name of the program.
1112 * Sets the name of the program. This name should <emphasis>not</emphasis>
1113 * be localized, contrast with g_set_application_name(). Note that for
1114 * thread-safety reasons this function can only be called once.
1117 g_set_prgname (const gchar *prgname)
1121 g_prgname = g_strdup (prgname);
1122 G_UNLOCK (g_prgname);
1125 G_LOCK_DEFINE_STATIC (g_application_name);
1126 static gchar *g_application_name = NULL;
1129 * g_get_application_name:
1131 * Gets a human-readable name for the application, as set by
1132 * g_set_application_name(). This name should be localized if
1133 * possible, and is intended for display to the user. Contrast with
1134 * g_get_prgname(), which gets a non-localized name. If
1135 * g_set_application_name() has not been called, returns the result of
1136 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1139 * Return value: human-readable application name. may return %NULL
1144 g_get_application_name (void)
1148 G_LOCK (g_application_name);
1149 retval = g_application_name;
1150 G_UNLOCK (g_application_name);
1153 return g_get_prgname ();
1159 * g_set_application_name:
1160 * @application_name: localized name of the application
1162 * Sets a human-readable name for the application. This name should be
1163 * localized if possible, and is intended for display to the user.
1164 * Contrast with g_set_prgname(), which sets a non-localized name.
1165 * g_set_prgname() will be called automatically by gtk_init(),
1166 * but g_set_application_name() will not.
1168 * Note that for thread safety reasons, this function can only
1171 * The application name will be used in contexts such as error messages,
1172 * or when displaying an application's name in the task list.
1177 g_set_application_name (const gchar *application_name)
1179 gboolean already_set = FALSE;
1181 G_LOCK (g_application_name);
1182 if (g_application_name)
1185 g_application_name = g_strdup (application_name);
1186 G_UNLOCK (g_application_name);
1189 g_warning ("g_set_application_name() called multiple times");
1193 * g_get_user_data_dir:
1195 * Returns a base directory in which to access application data such
1196 * as icons that is customized for a particular user.
1198 * On UNIX platforms this is determined using the mechanisms described in
1199 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1200 * XDG Base Directory Specification</ulink>.
1201 * In this case the directory retrieved will be XDG_DATA_HOME.
1203 * On Windows this is the folder to use for local (as opposed to
1204 * roaming) application data. See documentation for
1205 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1206 * what g_get_user_config_dir() returns.
1208 * Return value: a string owned by GLib that must not be modified
1213 g_get_user_data_dir (void)
1217 G_LOCK (g_utils_global);
1219 if (!g_user_data_dir)
1222 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1224 data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1226 if (data_dir && data_dir[0])
1227 data_dir = g_strdup (data_dir);
1229 if (!data_dir || !data_dir[0])
1234 data_dir = g_build_filename (g_home_dir, ".local",
1237 data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local",
1241 g_user_data_dir = data_dir;
1244 data_dir = g_user_data_dir;
1246 G_UNLOCK (g_utils_global);
1252 g_init_user_config_dir (void)
1256 if (!g_user_config_dir)
1259 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1261 config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1263 if (config_dir && config_dir[0])
1264 config_dir = g_strdup (config_dir);
1266 if (!config_dir || !config_dir[0])
1271 config_dir = g_build_filename (g_home_dir, ".config", NULL);
1273 config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
1276 g_user_config_dir = config_dir;
1281 * g_get_user_config_dir:
1283 * Returns a base directory in which to store user-specific application
1284 * configuration information such as user preferences and settings.
1286 * On UNIX platforms this is determined using the mechanisms described in
1287 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1288 * XDG Base Directory Specification</ulink>.
1289 * In this case the directory retrieved will be XDG_CONFIG_HOME.
1291 * On Windows this is the folder to use for local (as opposed to
1292 * roaming) application data. See documentation for
1293 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1294 * what g_get_user_data_dir() returns.
1296 * Return value: a string owned by GLib that must not be modified
1301 g_get_user_config_dir (void)
1303 G_LOCK (g_utils_global);
1305 g_init_user_config_dir ();
1307 G_UNLOCK (g_utils_global);
1309 return g_user_config_dir;
1313 * g_get_user_cache_dir:
1315 * Returns a base directory in which to store non-essential, cached
1316 * data specific to particular user.
1318 * On UNIX platforms this is determined using the mechanisms described in
1319 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1320 * XDG Base Directory Specification</ulink>.
1321 * In this case the directory retrieved will be XDG_CACHE_HOME.
1323 * On Windows is the directory that serves as a common repository for
1324 * temporary Internet files. A typical path is
1325 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1326 * See documentation for CSIDL_INTERNET_CACHE.
1328 * Return value: a string owned by GLib that must not be modified
1333 g_get_user_cache_dir (void)
1337 G_LOCK (g_utils_global);
1339 if (!g_user_cache_dir)
1342 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1344 cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1346 if (cache_dir && cache_dir[0])
1347 cache_dir = g_strdup (cache_dir);
1349 if (!cache_dir || !cache_dir[0])
1354 cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
1356 cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
1358 g_user_cache_dir = cache_dir;
1361 cache_dir = g_user_cache_dir;
1363 G_UNLOCK (g_utils_global);
1369 * g_get_user_runtime_dir:
1371 * Returns a directory that is unique to the current user on the local
1374 * On UNIX platforms this is determined using the mechanisms described in
1375 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1376 * XDG Base Directory Specification</ulink>. This is the directory
1377 * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
1378 * In the case that this variable is not set, GLib will issue a warning
1379 * message to stderr and return the value of g_get_user_cache_dir().
1381 * On Windows this is the folder to use for local (as opposed to
1382 * roaming) application data. See documentation for
1383 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1384 * what g_get_user_config_dir() returns.
1386 * Returns: a string owned by GLib that must not be modified or freed.
1391 g_get_user_runtime_dir (void)
1394 static const gchar *runtime_dir;
1395 static gsize initialised;
1397 if (g_once_init_enter (&initialised))
1399 runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1401 g_once_init_leave (&initialised, 1);
1407 /* Both fallback for UNIX and the default
1408 * in Windows: use the user cache directory.
1412 return g_get_user_cache_dir ();
1418 find_folder (OSType type)
1420 gchar *filename = NULL;
1423 if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1425 CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1429 CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1433 filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1437 filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1439 CFStringGetCString (path, filename,
1440 CFStringGetLength (path) * 3 + 1,
1441 kCFStringEncodingUTF8);
1455 load_user_special_dirs (void)
1457 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1458 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1459 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1460 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1461 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1462 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1463 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1464 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1467 #endif /* HAVE_CARBON */
1469 #if defined(G_OS_WIN32)
1471 load_user_special_dirs (void)
1473 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1477 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1479 static const GUID FOLDERID_Downloads =
1480 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1481 static const GUID FOLDERID_Public =
1482 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1486 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1487 "SHGetKnownFolderPath");
1489 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1490 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1492 if (p_SHGetKnownFolderPath == NULL)
1494 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1499 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1502 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1503 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1504 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1505 CoTaskMemFree (wcp);
1508 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1511 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1512 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1514 if (p_SHGetKnownFolderPath == NULL)
1517 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1522 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1525 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1526 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1527 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1528 CoTaskMemFree (wcp);
1531 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1534 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1535 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1537 #endif /* G_OS_WIN32 */
1539 static void g_init_user_config_dir (void);
1541 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1543 /* adapted from xdg-user-dir-lookup.c
1545 * Copyright (C) 2007 Red Hat Inc.
1547 * Permission is hereby granted, free of charge, to any person
1548 * obtaining a copy of this software and associated documentation files
1549 * (the "Software"), to deal in the Software without restriction,
1550 * including without limitation the rights to use, copy, modify, merge,
1551 * publish, distribute, sublicense, and/or sell copies of the Software,
1552 * and to permit persons to whom the Software is furnished to do so,
1553 * subject to the following conditions:
1555 * The above copyright notice and this permission notice shall be
1556 * included in all copies or substantial portions of the Software.
1558 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1559 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1560 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1561 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1562 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1563 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1564 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1568 load_user_special_dirs (void)
1575 g_init_user_config_dir ();
1576 config_file = g_build_filename (g_user_config_dir,
1580 if (!g_file_get_contents (config_file, &data, NULL, NULL))
1582 g_free (config_file);
1586 lines = g_strsplit (data, "\n", -1);
1587 n_lines = g_strv_length (lines);
1590 for (i = 0; i < n_lines; i++)
1592 gchar *buffer = lines[i];
1595 gboolean is_relative = FALSE;
1596 GUserDirectory directory;
1598 /* Remove newline at end */
1599 len = strlen (buffer);
1600 if (len > 0 && buffer[len - 1] == '\n')
1601 buffer[len - 1] = 0;
1604 while (*p == ' ' || *p == '\t')
1607 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1609 directory = G_USER_DIRECTORY_DESKTOP;
1610 p += strlen ("XDG_DESKTOP_DIR");
1612 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1614 directory = G_USER_DIRECTORY_DOCUMENTS;
1615 p += strlen ("XDG_DOCUMENTS_DIR");
1617 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1619 directory = G_USER_DIRECTORY_DOWNLOAD;
1620 p += strlen ("XDG_DOWNLOAD_DIR");
1622 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1624 directory = G_USER_DIRECTORY_MUSIC;
1625 p += strlen ("XDG_MUSIC_DIR");
1627 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1629 directory = G_USER_DIRECTORY_PICTURES;
1630 p += strlen ("XDG_PICTURES_DIR");
1632 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1634 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1635 p += strlen ("XDG_PUBLICSHARE_DIR");
1637 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1639 directory = G_USER_DIRECTORY_TEMPLATES;
1640 p += strlen ("XDG_TEMPLATES_DIR");
1642 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1644 directory = G_USER_DIRECTORY_VIDEOS;
1645 p += strlen ("XDG_VIDEOS_DIR");
1650 while (*p == ' ' || *p == '\t')
1657 while (*p == ' ' || *p == '\t')
1664 if (strncmp (p, "$HOME", 5) == 0)
1672 d = strrchr (p, '"');
1679 /* remove trailing slashes */
1681 if (d[len - 1] == '/')
1687 g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
1690 g_user_special_dirs[directory] = g_strdup (d);
1694 g_free (config_file);
1697 #endif /* G_OS_UNIX && !HAVE_CARBON */
1701 * g_reload_user_special_dirs_cache:
1703 * Resets the cache used for g_get_user_special_dir(), so
1704 * that the latest on-disk version is used. Call this only
1705 * if you just changed the data on disk yourself.
1707 * Due to threadsafety issues this may cause leaking of strings
1708 * that were previously returned from g_get_user_special_dir()
1709 * that can't be freed. We ensure to only leak the data for
1710 * the directories that actually changed value though.
1715 g_reload_user_special_dirs_cache (void)
1719 G_LOCK (g_utils_global);
1721 if (g_user_special_dirs != NULL)
1723 /* save a copy of the pointer, to check if some memory can be preserved */
1724 char **old_g_user_special_dirs = g_user_special_dirs;
1727 /* recreate and reload our cache */
1728 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1729 load_user_special_dirs ();
1731 /* only leak changed directories */
1732 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1734 old_val = old_g_user_special_dirs[i];
1735 if (g_user_special_dirs[i] == NULL)
1737 g_user_special_dirs[i] = old_val;
1739 else if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1742 g_free (g_user_special_dirs[i]);
1743 g_user_special_dirs[i] = old_val;
1749 /* free the old array */
1750 g_free (old_g_user_special_dirs);
1753 G_UNLOCK (g_utils_global);
1757 * g_get_user_special_dir:
1758 * @directory: the logical id of special directory
1760 * Returns the full path of a special directory using its logical id.
1762 * On Unix this is done using the XDG special user directories.
1763 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1764 * falls back to <filename>$HOME/Desktop</filename> when XDG special
1765 * user directories have not been set up.
1767 * Depending on the platform, the user might be able to change the path
1768 * of the special directory without requiring the session to restart; GLib
1769 * will not reflect any change once the special directories are loaded.
1771 * Return value: the path to the specified special directory, or %NULL
1772 * if the logical id was not found. The returned string is owned by
1773 * GLib and should not be modified or freed.
1778 g_get_user_special_dir (GUserDirectory directory)
1780 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1781 directory < G_USER_N_DIRECTORIES, NULL);
1783 G_LOCK (g_utils_global);
1785 if (G_UNLIKELY (g_user_special_dirs == NULL))
1787 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1789 load_user_special_dirs ();
1791 /* Special-case desktop for historical compatibility */
1792 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1796 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
1797 g_build_filename (g_home_dir, "Desktop", NULL);
1801 G_UNLOCK (g_utils_global);
1803 return g_user_special_dirs[directory];
1808 #undef g_get_system_data_dirs
1811 get_module_for_address (gconstpointer address)
1813 /* Holds the g_utils_global lock */
1815 static gboolean beenhere = FALSE;
1816 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1817 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1818 HMODULE hmodule = NULL;
1825 p_GetModuleHandleExA =
1826 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1827 "GetModuleHandleExA");
1831 if (p_GetModuleHandleExA == NULL ||
1832 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1833 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1836 MEMORY_BASIC_INFORMATION mbi;
1837 VirtualQuery (address, &mbi, sizeof (mbi));
1838 hmodule = (HMODULE) mbi.AllocationBase;
1845 get_module_share_dir (gconstpointer address)
1851 hmodule = get_module_for_address (address);
1852 if (hmodule == NULL)
1855 filename = g_win32_get_package_installation_directory_of_module (hmodule);
1856 retval = g_build_filename (filename, "share", NULL);
1862 const gchar * const *
1863 g_win32_get_system_data_dirs_for_module (void (*address_of_function)())
1867 static GHashTable *per_module_data_dirs = NULL;
1872 if (address_of_function)
1874 G_LOCK (g_utils_global);
1875 hmodule = get_module_for_address (address_of_function);
1876 if (hmodule != NULL)
1878 if (per_module_data_dirs == NULL)
1879 per_module_data_dirs = g_hash_table_new (NULL, NULL);
1882 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1886 G_UNLOCK (g_utils_global);
1887 return (const gchar * const *) retval;
1893 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1895 /* Documents and Settings\All Users\Application Data */
1896 p = get_special_folder (CSIDL_COMMON_APPDATA);
1898 g_array_append_val (data_dirs, p);
1900 /* Documents and Settings\All Users\Documents */
1901 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1903 g_array_append_val (data_dirs, p);
1905 /* Using the above subfolders of Documents and Settings perhaps
1906 * makes sense from a Windows perspective.
1908 * But looking at the actual use cases of this function in GTK+
1909 * and GNOME software, what we really want is the "share"
1910 * subdirectory of the installation directory for the package
1911 * our caller is a part of.
1913 * The address_of_function parameter, if non-NULL, points to a
1914 * function in the calling module. Use that to determine that
1915 * module's installation folder, and use its "share" subfolder.
1917 * Additionally, also use the "share" subfolder of the installation
1918 * locations of GLib and the .exe file being run.
1920 * To guard against none of the above being what is really wanted,
1921 * callers of this function should have Win32-specific code to look
1922 * up their installation folder themselves, and handle a subfolder
1923 * "share" of it in the same way as the folders returned from this
1927 p = get_module_share_dir (address_of_function);
1929 g_array_append_val (data_dirs, p);
1931 if (glib_dll != NULL)
1933 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1934 p = g_build_filename (glib_root, "share", NULL);
1936 g_array_append_val (data_dirs, p);
1940 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1941 p = g_build_filename (exe_root, "share", NULL);
1943 g_array_append_val (data_dirs, p);
1946 retval = (gchar **) g_array_free (data_dirs, FALSE);
1948 if (address_of_function)
1950 if (hmodule != NULL)
1951 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1952 G_UNLOCK (g_utils_global);
1955 return (const gchar * const *) retval;
1961 * g_get_system_data_dirs:
1963 * Returns an ordered list of base directories in which to access
1964 * system-wide application data.
1966 * On UNIX platforms this is determined using the mechanisms described in
1967 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1968 * XDG Base Directory Specification</ulink>
1969 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1971 * On Windows the first elements in the list are the Application Data
1972 * and Documents folders for All Users. (These can be determined only
1973 * on Windows 2000 or later and are not present in the list on other
1974 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1975 * CSIDL_COMMON_DOCUMENTS.
1977 * Then follows the "share" subfolder in the installation folder for
1978 * the package containing the DLL that calls this function, if it can
1981 * Finally the list contains the "share" subfolder in the installation
1982 * folder for GLib, and in the installation folder for the package the
1983 * application's .exe file belongs to.
1985 * The installation folders above are determined by looking up the
1986 * folder where the module (DLL or EXE) in question is located. If the
1987 * folder's name is "bin", its parent is used, otherwise the folder
1990 * Note that on Windows the returned list can vary depending on where
1991 * this function is called.
1993 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1994 * not be modified or freed.
1997 const gchar * const *
1998 g_get_system_data_dirs (void)
2000 gchar **data_dir_vector;
2002 G_LOCK (g_utils_global);
2004 if (!g_system_data_dirs)
2007 data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2009 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2011 if (!data_dirs || !data_dirs[0])
2012 data_dirs = "/usr/local/share/:/usr/share/";
2014 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2017 g_system_data_dirs = data_dir_vector;
2020 data_dir_vector = g_system_data_dirs;
2022 G_UNLOCK (g_utils_global);
2024 return (const gchar * const *) data_dir_vector;
2028 * g_get_system_config_dirs:
2030 * Returns an ordered list of base directories in which to access
2031 * system-wide configuration information.
2033 * On UNIX platforms this is determined using the mechanisms described in
2034 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2035 * XDG Base Directory Specification</ulink>.
2036 * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2038 * On Windows is the directory that contains application data for all users.
2039 * A typical path is C:\Documents and Settings\All Users\Application Data.
2040 * This folder is used for application data that is not user specific.
2041 * For example, an application can store a spell-check dictionary, a database
2042 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2043 * This information will not roam and is available to anyone using the computer.
2045 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2046 * not be modified or freed.
2049 const gchar * const *
2050 g_get_system_config_dirs (void)
2052 gchar *conf_dirs, **conf_dir_vector;
2054 G_LOCK (g_utils_global);
2056 if (!g_system_config_dirs)
2059 conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2062 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2067 /* Return empty list */
2068 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2071 conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2073 if (!conf_dirs || !conf_dirs[0])
2074 conf_dirs = "/etc/xdg";
2076 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2079 g_system_config_dirs = conf_dir_vector;
2082 conf_dir_vector = g_system_config_dirs;
2083 G_UNLOCK (g_utils_global);
2085 return (const gchar * const *) conf_dir_vector;
2089 * g_nullify_pointer:
2090 * @nullify_location: the memory address of the pointer.
2092 * Set the pointer at the specified location to %NULL.
2095 g_nullify_pointer (gpointer *nullify_location)
2097 g_return_if_fail (nullify_location != NULL);
2099 *nullify_location = NULL;
2102 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2103 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2104 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2105 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2106 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2107 #define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2109 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2110 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2111 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2112 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2113 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2114 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2118 * @size: a size in bytes
2120 * Formats a size (for example the size of a file) into a human readable
2121 * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
2122 * and are displayed rounded to the nearest tenth. E.g. the file size
2123 * 3292528 bytes will be converted into the string "3.2 MB".
2125 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2127 * This string should be freed with g_free() when not needed any longer.
2129 * See g_format_size_full() for more options about how the size might be
2132 * Returns: a newly-allocated formatted string containing a human readable
2138 g_format_size (guint64 size)
2140 return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2145 * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2146 * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2147 * of the returned string. For example, "45.6 kB (45,612 bytes)".
2148 * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2149 * suffixes. IEC units should only be used for reporting things with
2150 * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2151 * Network and storage sizes should be reported in the normal SI units.
2153 * Flags to modify the format of the string returned by g_format_size_full().
2157 * g_format_size_full:
2158 * @size: a size in bytes
2159 * @flags: #GFormatSizeFlags to modify the output
2163 * This function is similar to g_format_size() but allows for flags
2164 * that modify the output. See #GFormatSizeFlags.
2166 * Returns: a newly-allocated formatted string containing a human
2167 * readable file size
2172 g_format_size_full (guint64 size,
2173 GFormatSizeFlags flags)
2177 string = g_string_new (NULL);
2179 if (flags & G_FORMAT_SIZE_IEC_UNITS)
2181 if (size < KIBIBYTE_FACTOR)
2183 g_string_printf (string,
2184 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2186 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2189 else if (size < MEBIBYTE_FACTOR)
2190 g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2191 else if (size < GIBIBYTE_FACTOR)
2192 g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2194 else if (size < TEBIBYTE_FACTOR)
2195 g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2197 else if (size < PEBIBYTE_FACTOR)
2198 g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2200 else if (size < EXBIBYTE_FACTOR)
2201 g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2204 g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2208 if (size < KILOBYTE_FACTOR)
2210 g_string_printf (string,
2211 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2213 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2216 else if (size < MEGABYTE_FACTOR)
2217 g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2219 else if (size < GIGABYTE_FACTOR)
2220 g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2222 else if (size < TERABYTE_FACTOR)
2223 g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2224 else if (size < PETABYTE_FACTOR)
2225 g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2227 else if (size < EXABYTE_FACTOR)
2228 g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2231 g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2234 if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2236 /* First problem: we need to use the number of bytes to decide on
2237 * the plural form that is used for display, but the number of
2238 * bytes potentially exceeds the size of a guint (which is what
2239 * ngettext() takes).
2241 * From a pragmatic standpoint, it seems that all known languages
2242 * base plural forms on one or both of the following:
2244 * - the lowest digits of the number
2246 * - if the number if greater than some small value
2248 * Here's how we fake it: Draw an arbitrary line at one thousand.
2249 * If the number is below that, then fine. If it is above it,
2250 * then we take the modulus of the number by one thousand (in
2251 * order to keep the lowest digits) and add one thousand to that
2252 * (in order to ensure that 1001 is not treated the same as 1).
2254 guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2256 /* Second problem: we need to translate the string "%u byte" and
2257 * "%u bytes" for pluralisation, but the correct number format to
2258 * use for a gsize is different depending on which architecture
2261 * Solution: format the number separately and use "%s bytes" on
2264 const gchar *translated_format;
2265 gchar *formatted_number;
2267 /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2268 translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2269 /* XXX: Windows doesn't support the "'" format modifier, so we
2270 * must not use it there. Instead, just display the number
2271 * without separation. Bug #655336 is open until a solution is
2275 formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2277 formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2280 g_string_append (string, " (");
2281 g_string_append_printf (string, translated_format, formatted_number);
2282 g_free (formatted_number);
2283 g_string_append (string, ")");
2286 return g_string_free (string, FALSE);
2290 * g_format_size_for_display:
2291 * @size: a size in bytes
2293 * Formats a size (for example the size of a file) into a human
2294 * readable string. Sizes are rounded to the nearest size prefix
2295 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2296 * E.g. the file size 3292528 bytes will be converted into the
2299 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2301 * This string should be freed with g_free() when not needed any longer.
2303 * Returns: a newly-allocated formatted string containing a human
2304 * readable file size
2308 * Deprecated:2.30: This function is broken due to its use of SI
2309 * suffixes to denote IEC units. Use g_format_size() instead.
2312 g_format_size_for_display (goffset size)
2314 if (size < (goffset) KIBIBYTE_FACTOR)
2315 return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2318 gdouble displayed_size;
2320 if (size < (goffset) MEBIBYTE_FACTOR)
2322 displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2323 return g_strdup_printf (_("%.1f KB"), displayed_size);
2325 else if (size < (goffset) GIBIBYTE_FACTOR)
2327 displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2328 return g_strdup_printf (_("%.1f MB"), displayed_size);
2330 else if (size < (goffset) TEBIBYTE_FACTOR)
2332 displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2333 return g_strdup_printf (_("%.1f GB"), displayed_size);
2335 else if (size < (goffset) PEBIBYTE_FACTOR)
2337 displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2338 return g_strdup_printf (_("%.1f TB"), displayed_size);
2340 else if (size < (goffset) EXBIBYTE_FACTOR)
2342 displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2343 return g_strdup_printf (_("%.1f PB"), displayed_size);
2347 displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2348 return g_strdup_printf (_("%.1f EB"), displayed_size);
2353 #if defined (G_OS_WIN32) && !defined (_WIN64)
2355 /* Binary compatibility versions. Not for newly compiled code. */
2357 #undef g_find_program_in_path
2360 g_find_program_in_path (const gchar *program)
2362 gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
2363 gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
2366 g_free (utf8_program);
2367 if (utf8_retval == NULL)
2369 retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
2370 g_free (utf8_retval);
2375 #undef g_get_user_name
2378 g_get_user_name (void)
2380 g_get_any_init_locked ();
2381 return g_user_name_cp;
2384 #undef g_get_real_name
2387 g_get_real_name (void)
2389 g_get_any_init_locked ();
2390 return g_real_name_cp;
2393 #undef g_get_home_dir
2396 g_get_home_dir (void)
2398 g_get_any_init_locked ();
2399 return g_home_dir_cp;
2402 #undef g_get_tmp_dir
2405 g_get_tmp_dir (void)
2407 g_get_any_init_locked ();
2408 return g_tmp_dir_cp;