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(), for the reasons
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: 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"));
664 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
665 g_tmp_dir = g_strdup (g_getenv ("TMP"));
666 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
667 g_tmp_dir = g_strdup (g_getenv ("TEMP"));
670 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
671 g_tmp_dir = get_windows_directory_root ();
674 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
677 g_tmp_dir = g_strdup (P_tmpdir);
678 k = strlen (g_tmp_dir);
679 if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
680 g_tmp_dir[k - 1] = '\0';
684 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
686 g_tmp_dir = g_strdup ("/tmp");
688 #endif /* !G_OS_WIN32 */
691 /* We check $HOME first for Win32, though it is a last resort for Unix
692 * where we prefer the results of getpwuid().
694 g_home_dir = g_strdup (g_getenv ("HOME"));
696 /* Only believe HOME if it is an absolute path and exists */
699 if (!(g_path_is_absolute (g_home_dir) &&
700 g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
707 /* In case HOME is Unix-style (it happens), convert it to
713 while ((p = strchr (g_home_dir, '/')) != NULL)
719 /* USERPROFILE is probably the closest equivalent to $HOME? */
720 if (g_getenv ("USERPROFILE") != NULL)
721 g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
725 g_home_dir = get_special_folder (CSIDL_PROFILE);
728 g_home_dir = get_windows_directory_root ();
729 #endif /* G_OS_WIN32 */
733 struct passwd *pw = NULL;
734 gpointer buffer = NULL;
738 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
740 # ifdef _SC_GETPW_R_SIZE_MAX
741 /* This reurns the maximum length */
742 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
746 # else /* _SC_GETPW_R_SIZE_MAX */
748 # endif /* _SC_GETPW_R_SIZE_MAX */
750 logname = (gchar *) g_getenv ("LOGNAME");
755 /* we allocate 6 extra bytes to work around a bug in
756 * Mac OS < 10.3. See #156446
758 buffer = g_malloc (bufsize + 6);
761 # ifdef HAVE_POSIX_GETPWUID_R
763 error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
764 if (!pw || (pw->pw_uid != getuid ())) {
765 /* LOGNAME is lying, fall back to looking up the uid */
766 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
769 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
771 error = error < 0 ? errno : error;
772 # else /* HAVE_NONPOSIX_GETPWUID_R */
773 /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
774 # if defined(_AIX) || defined(__hpux)
775 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
776 pw = error == 0 ? &pwd : NULL;
779 pw = getpwnam_r (logname, &pwd, buffer, bufsize);
780 if (!pw || (pw->pw_uid != getuid ())) {
781 /* LOGNAME is lying, fall back to looking up the uid */
782 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
785 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
787 error = pw ? 0 : errno;
789 # endif /* HAVE_NONPOSIX_GETPWUID_R */
793 /* we bail out prematurely if the user id can't be found
794 * (should be pretty rare case actually), or if the buffer
795 * should be sufficiently big and lookups are still not
798 if (error == 0 || error == ENOENT)
800 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
804 if (bufsize > 32 * 1024)
806 g_warning ("getpwuid_r(): failed due to: %s.",
815 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
820 pw = getpwuid (getuid ());
825 g_user_name = g_strdup (pw->pw_name);
827 if (pw->pw_gecos && *pw->pw_gecos != '\0')
829 gchar **gecos_fields;
832 /* split the gecos field and substitute '&' */
833 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
834 name_parts = g_strsplit (gecos_fields[0], "&", 0);
835 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
836 g_real_name = g_strjoinv (pw->pw_name, name_parts);
837 g_strfreev (gecos_fields);
838 g_strfreev (name_parts);
842 g_home_dir = g_strdup (pw->pw_dir);
847 #else /* !HAVE_PWD_H */
852 wchar_t buffer[UNLEN+1];
854 if (GetUserNameW (buffer, (LPDWORD) &len))
856 g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
857 g_real_name = g_strdup (g_user_name);
860 #endif /* G_OS_WIN32 */
862 #endif /* !HAVE_PWD_H */
866 g_home_dir = g_strdup (g_getenv ("HOME"));
870 /* change '\\' in %HOME% to '/' */
871 g_strdelimit (g_home_dir, "\\",'/');
874 g_user_name = g_strdup ("somebody");
876 g_real_name = g_strdup ("Unknown");
880 gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
882 DWORD size = sizeof (hostname);
883 gboolean hostname_fail = (!GetComputerName (hostname, &size));
885 g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
889 g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
890 g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
891 g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
894 g_tmp_dir_cp = g_strdup ("\\");
896 g_user_name_cp = g_strdup ("somebody");
898 g_real_name_cp = g_strdup ("Unknown");
900 /* home_dir might be NULL, unlike tmp_dir, user_name and
904 g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
906 g_home_dir_cp = NULL;
907 #endif /* G_OS_WIN32 */
911 g_get_any_init (void)
914 g_get_any_init_do ();
918 g_get_any_init_locked (void)
920 G_LOCK (g_utils_global);
922 G_UNLOCK (g_utils_global);
929 * Gets the user name of the current user. The encoding of the returned
930 * string is system-defined. On UNIX, it might be the preferred file name
931 * encoding, or something else, and there is no guarantee that it is even
932 * consistent on a machine. On Windows, it is always UTF-8.
934 * Returns: the user name of the current user.
937 g_get_user_name (void)
939 g_get_any_init_locked ();
946 * Gets the real name of the user. This usually comes from the user's entry
947 * in the <filename>passwd</filename> file. The encoding of the returned
948 * string is system-defined. (On Windows, it is, however, always UTF-8.)
949 * If the real user name cannot be determined, the string "Unknown" is
952 * Returns: the user's real name.
955 g_get_real_name (void)
957 g_get_any_init_locked ();
964 * Gets the current user's home directory as defined in the
967 * Note that in contrast to traditional UNIX tools, this function
968 * prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
969 * environment variable.
971 * One of the reasons for this decision is that applications in many
972 * cases need special handling to deal with the case where
973 * <envar>HOME</envar> is
975 * <member>Not owned by the user</member>
976 * <member>Not writeable</member>
977 * <member>Not even readable</member>
979 * Since applications are in general <emphasis>not</emphasis> written
980 * to deal with these situations it was considered better to make
981 * g_get_home_dir() not pay attention to <envar>HOME</envar> and to
982 * return the real home directory for the user. If applications
983 * want to pay attention to <envar>HOME</envar>, they can do:
985 * const char *homedir = g_getenv ("HOME");
987 * homedir = g_get_home_dir (<!-- -->);
990 * Returns: the current user's home directory
993 g_get_home_dir (void)
995 g_get_any_init_locked ();
1002 * Gets the directory to use for temporary files. This is found from
1003 * inspecting the environment variables <envar>TMPDIR</envar>,
1004 * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
1005 * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
1006 * The encoding of the returned string is system-defined. On Windows,
1007 * it is always UTF-8. The return value is never %NULL or the empty string.
1009 * Returns: the directory to use for temporary files.
1012 g_get_tmp_dir (void)
1014 g_get_any_init_locked ();
1021 * Return a name for the machine.
1023 * The returned name is not necessarily a fully-qualified domain name,
1024 * or even present in DNS or some other name service at all. It need
1025 * not even be unique on your local network or site, but usually it
1026 * is. Callers should not rely on the return value having any specific
1027 * properties like uniqueness for security purposes. Even if the name
1028 * of the machine is changed while an application is running, the
1029 * return value from this function does not change. The returned
1030 * string is owned by GLib and should not be modified or freed. If no
1031 * name can be determined, a default fixed string "localhost" is
1034 * Returns: the host name of the machine.
1039 g_get_host_name (void)
1041 g_get_any_init_locked ();
1045 G_LOCK_DEFINE_STATIC (g_prgname);
1046 static gchar *g_prgname = NULL;
1051 * Gets the name of the program. This name should <emphasis>not</emphasis>
1052 * be localized, contrast with g_get_application_name().
1053 * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1054 * which is called by gtk_init(). The program name is found by taking
1055 * the last component of <literal>argv[0]</literal>.)
1057 * Returns: the name of the program. The returned string belongs
1058 * to GLib and must not be modified or freed.
1061 g_get_prgname (void)
1067 if (g_prgname == NULL)
1069 static gboolean beenhere = FALSE;
1073 gchar *utf8_buf = NULL;
1074 wchar_t buf[MAX_PATH+1];
1077 if (GetModuleFileNameW (GetModuleHandle (NULL),
1078 buf, G_N_ELEMENTS (buf)) > 0)
1079 utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1083 g_prgname = g_path_get_basename (utf8_buf);
1090 G_UNLOCK (g_prgname);
1097 * @prgname: the name of the program.
1099 * Sets the name of the program. This name should <emphasis>not</emphasis>
1100 * be localized, contrast with g_set_application_name(). Note that for
1101 * thread-safety reasons this function can only be called once.
1104 g_set_prgname (const gchar *prgname)
1108 g_prgname = g_strdup (prgname);
1109 G_UNLOCK (g_prgname);
1112 G_LOCK_DEFINE_STATIC (g_application_name);
1113 static gchar *g_application_name = NULL;
1116 * g_get_application_name:
1118 * Gets a human-readable name for the application, as set by
1119 * g_set_application_name(). This name should be localized if
1120 * possible, and is intended for display to the user. Contrast with
1121 * g_get_prgname(), which gets a non-localized name. If
1122 * g_set_application_name() has not been called, returns the result of
1123 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1126 * Return value: human-readable application name. may return %NULL
1131 g_get_application_name (void)
1135 G_LOCK (g_application_name);
1136 retval = g_application_name;
1137 G_UNLOCK (g_application_name);
1140 return g_get_prgname ();
1146 * g_set_application_name:
1147 * @application_name: localized name of the application
1149 * Sets a human-readable name for the application. This name should be
1150 * localized if possible, and is intended for display to the user.
1151 * Contrast with g_set_prgname(), which sets a non-localized name.
1152 * g_set_prgname() will be called automatically by gtk_init(),
1153 * but g_set_application_name() will not.
1155 * Note that for thread safety reasons, this function can only
1158 * The application name will be used in contexts such as error messages,
1159 * or when displaying an application's name in the task list.
1164 g_set_application_name (const gchar *application_name)
1166 gboolean already_set = FALSE;
1168 G_LOCK (g_application_name);
1169 if (g_application_name)
1172 g_application_name = g_strdup (application_name);
1173 G_UNLOCK (g_application_name);
1176 g_warning ("g_set_application_name() called multiple times");
1180 * g_get_user_data_dir:
1182 * Returns a base directory in which to access application data such
1183 * as icons that is customized for a particular user.
1185 * On UNIX platforms this is determined using the mechanisms described in
1186 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1187 * XDG Base Directory Specification</ulink>.
1188 * In this case the directory retrieved will be XDG_DATA_HOME.
1190 * On Windows this is the folder to use for local (as opposed to
1191 * roaming) application data. See documentation for
1192 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1193 * what g_get_user_config_dir() returns.
1195 * Return value: a string owned by GLib that must not be modified
1200 g_get_user_data_dir (void)
1204 G_LOCK (g_utils_global);
1206 if (!g_user_data_dir)
1209 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1211 data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1213 if (data_dir && data_dir[0])
1214 data_dir = g_strdup (data_dir);
1216 if (!data_dir || !data_dir[0])
1221 data_dir = g_build_filename (g_home_dir, ".local",
1224 data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local",
1228 g_user_data_dir = data_dir;
1231 data_dir = g_user_data_dir;
1233 G_UNLOCK (g_utils_global);
1239 g_init_user_config_dir (void)
1243 if (!g_user_config_dir)
1246 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
1248 config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
1250 if (config_dir && config_dir[0])
1251 config_dir = g_strdup (config_dir);
1253 if (!config_dir || !config_dir[0])
1258 config_dir = g_build_filename (g_home_dir, ".config", NULL);
1260 config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
1263 g_user_config_dir = config_dir;
1268 * g_get_user_config_dir:
1270 * Returns a base directory in which to store user-specific application
1271 * configuration information such as user preferences and settings.
1273 * On UNIX platforms this is determined using the mechanisms described in
1274 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1275 * XDG Base Directory Specification</ulink>.
1276 * In this case the directory retrieved will be XDG_CONFIG_HOME.
1278 * On Windows this is the folder to use for local (as opposed to
1279 * roaming) application data. See documentation for
1280 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1281 * what g_get_user_data_dir() returns.
1283 * Return value: a string owned by GLib that must not be modified
1288 g_get_user_config_dir (void)
1290 G_LOCK (g_utils_global);
1292 g_init_user_config_dir ();
1294 G_UNLOCK (g_utils_global);
1296 return g_user_config_dir;
1300 * g_get_user_cache_dir:
1302 * Returns a base directory in which to store non-essential, cached
1303 * data specific to particular user.
1305 * On UNIX platforms this is determined using the mechanisms described in
1306 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1307 * XDG Base Directory Specification</ulink>.
1308 * In this case the directory retrieved will be XDG_CACHE_HOME.
1310 * On Windows is the directory that serves as a common repository for
1311 * temporary Internet files. A typical path is
1312 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
1313 * See documentation for CSIDL_INTERNET_CACHE.
1315 * Return value: a string owned by GLib that must not be modified
1320 g_get_user_cache_dir (void)
1324 G_LOCK (g_utils_global);
1326 if (!g_user_cache_dir)
1329 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
1331 cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
1333 if (cache_dir && cache_dir[0])
1334 cache_dir = g_strdup (cache_dir);
1336 if (!cache_dir || !cache_dir[0])
1341 cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
1343 cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
1345 g_user_cache_dir = cache_dir;
1348 cache_dir = g_user_cache_dir;
1350 G_UNLOCK (g_utils_global);
1356 * g_get_user_runtime_dir:
1358 * Returns a directory that is unique to the current user on the local
1361 * On UNIX platforms this is determined using the mechanisms described in
1362 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1363 * XDG Base Directory Specification</ulink>. This is the directory
1364 * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
1365 * In the case that this variable is not set, GLib will issue a warning
1366 * message to stderr and return the value of g_get_user_cache_dir().
1368 * On Windows this is the folder to use for local (as opposed to
1369 * roaming) application data. See documentation for
1370 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
1371 * what g_get_user_config_dir() returns.
1373 * Returns: a string owned by GLib that must not be modified or freed.
1378 g_get_user_runtime_dir (void)
1381 static const gchar *runtime_dir;
1382 static gsize initialised;
1384 if (g_once_init_enter (&initialised))
1386 runtime_dir = g_strdup (getenv ("XDG_RUNTIME_DIR"));
1388 g_once_init_leave (&initialised, 1);
1394 /* Both fallback for UNIX and the default
1395 * in Windows: use the user cache directory.
1399 return g_get_user_cache_dir ();
1405 find_folder (OSType type)
1407 gchar *filename = NULL;
1410 if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
1412 CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
1416 CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
1420 filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
1424 filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
1426 CFStringGetCString (path, filename,
1427 CFStringGetLength (path) * 3 + 1,
1428 kCFStringEncodingUTF8);
1442 load_user_special_dirs (void)
1444 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
1445 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
1446 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
1447 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
1448 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
1449 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
1450 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
1451 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
1454 #endif /* HAVE_CARBON */
1456 #if defined(G_OS_WIN32)
1458 load_user_special_dirs (void)
1460 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
1464 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
1466 static const GUID FOLDERID_Downloads =
1467 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
1468 static const GUID FOLDERID_Public =
1469 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
1473 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
1474 "SHGetKnownFolderPath");
1476 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1477 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
1479 if (p_SHGetKnownFolderPath == NULL)
1481 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1486 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
1489 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1490 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
1491 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1492 CoTaskMemFree (wcp);
1495 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
1498 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
1499 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
1501 if (p_SHGetKnownFolderPath == NULL)
1504 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1509 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
1512 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
1513 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
1514 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1515 CoTaskMemFree (wcp);
1518 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1521 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
1522 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
1524 #endif /* G_OS_WIN32 */
1526 static void g_init_user_config_dir (void);
1528 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
1530 /* adapted from xdg-user-dir-lookup.c
1532 * Copyright (C) 2007 Red Hat Inc.
1534 * Permission is hereby granted, free of charge, to any person
1535 * obtaining a copy of this software and associated documentation files
1536 * (the "Software"), to deal in the Software without restriction,
1537 * including without limitation the rights to use, copy, modify, merge,
1538 * publish, distribute, sublicense, and/or sell copies of the Software,
1539 * and to permit persons to whom the Software is furnished to do so,
1540 * subject to the following conditions:
1542 * The above copyright notice and this permission notice shall be
1543 * included in all copies or substantial portions of the Software.
1545 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1546 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1547 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1548 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
1549 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
1550 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
1551 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1555 load_user_special_dirs (void)
1562 g_init_user_config_dir ();
1563 config_file = g_build_filename (g_user_config_dir,
1567 if (!g_file_get_contents (config_file, &data, NULL, NULL))
1569 g_free (config_file);
1573 lines = g_strsplit (data, "\n", -1);
1574 n_lines = g_strv_length (lines);
1577 for (i = 0; i < n_lines; i++)
1579 gchar *buffer = lines[i];
1582 gboolean is_relative = FALSE;
1583 GUserDirectory directory;
1585 /* Remove newline at end */
1586 len = strlen (buffer);
1587 if (len > 0 && buffer[len - 1] == '\n')
1588 buffer[len - 1] = 0;
1591 while (*p == ' ' || *p == '\t')
1594 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
1596 directory = G_USER_DIRECTORY_DESKTOP;
1597 p += strlen ("XDG_DESKTOP_DIR");
1599 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
1601 directory = G_USER_DIRECTORY_DOCUMENTS;
1602 p += strlen ("XDG_DOCUMENTS_DIR");
1604 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
1606 directory = G_USER_DIRECTORY_DOWNLOAD;
1607 p += strlen ("XDG_DOWNLOAD_DIR");
1609 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
1611 directory = G_USER_DIRECTORY_MUSIC;
1612 p += strlen ("XDG_MUSIC_DIR");
1614 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
1616 directory = G_USER_DIRECTORY_PICTURES;
1617 p += strlen ("XDG_PICTURES_DIR");
1619 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
1621 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
1622 p += strlen ("XDG_PUBLICSHARE_DIR");
1624 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
1626 directory = G_USER_DIRECTORY_TEMPLATES;
1627 p += strlen ("XDG_TEMPLATES_DIR");
1629 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
1631 directory = G_USER_DIRECTORY_VIDEOS;
1632 p += strlen ("XDG_VIDEOS_DIR");
1637 while (*p == ' ' || *p == '\t')
1644 while (*p == ' ' || *p == '\t')
1651 if (strncmp (p, "$HOME", 5) == 0)
1659 d = strrchr (p, '"');
1666 /* remove trailing slashes */
1668 if (d[len - 1] == '/')
1674 g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
1677 g_user_special_dirs[directory] = g_strdup (d);
1681 g_free (config_file);
1684 #endif /* G_OS_UNIX && !HAVE_CARBON */
1688 * g_reload_user_special_dirs_cache:
1690 * Resets the cache used for g_get_user_special_dir(), so
1691 * that the latest on-disk version is used. Call this only
1692 * if you just changed the data on disk yourself.
1694 * Due to threadsafety issues this may cause leaking of strings
1695 * that were previously returned from g_get_user_special_dir()
1696 * that can't be freed. We ensure to only leak the data for
1697 * the directories that actually changed value though.
1702 g_reload_user_special_dirs_cache (void)
1706 G_LOCK (g_utils_global);
1708 if (g_user_special_dirs != NULL)
1710 /* save a copy of the pointer, to check if some memory can be preserved */
1711 char **old_g_user_special_dirs = g_user_special_dirs;
1714 /* recreate and reload our cache */
1715 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1716 load_user_special_dirs ();
1718 /* only leak changed directories */
1719 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
1721 old_val = old_g_user_special_dirs[i];
1722 if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
1725 g_free (g_user_special_dirs[i]);
1726 g_user_special_dirs[i] = old_val;
1732 /* free the old array */
1733 g_free (old_g_user_special_dirs);
1736 G_UNLOCK (g_utils_global);
1740 * g_get_user_special_dir:
1741 * @directory: the logical id of special directory
1743 * Returns the full path of a special directory using its logical id.
1745 * On Unix this is done using the XDG special user directories.
1746 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
1747 * falls back to <filename>$HOME/Desktop</filename> when XDG special
1748 * user directories have not been set up.
1750 * Depending on the platform, the user might be able to change the path
1751 * of the special directory without requiring the session to restart; GLib
1752 * will not reflect any change once the special directories are loaded.
1754 * Return value: the path to the specified special directory, or %NULL
1755 * if the logical id was not found. The returned string is owned by
1756 * GLib and should not be modified or freed.
1761 g_get_user_special_dir (GUserDirectory directory)
1763 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
1764 directory < G_USER_N_DIRECTORIES, NULL);
1766 G_LOCK (g_utils_global);
1768 if (G_UNLIKELY (g_user_special_dirs == NULL))
1770 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
1772 load_user_special_dirs ();
1774 /* Special-case desktop for historical compatibility */
1775 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
1779 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
1780 g_build_filename (g_home_dir, "Desktop", NULL);
1784 G_UNLOCK (g_utils_global);
1786 return g_user_special_dirs[directory];
1791 #undef g_get_system_data_dirs
1794 get_module_for_address (gconstpointer address)
1796 /* Holds the g_utils_global lock */
1798 static gboolean beenhere = FALSE;
1799 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
1800 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
1801 HMODULE hmodule = NULL;
1808 p_GetModuleHandleExA =
1809 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
1810 "GetModuleHandleExA");
1814 if (p_GetModuleHandleExA == NULL ||
1815 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
1816 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
1819 MEMORY_BASIC_INFORMATION mbi;
1820 VirtualQuery (address, &mbi, sizeof (mbi));
1821 hmodule = (HMODULE) mbi.AllocationBase;
1828 get_module_share_dir (gconstpointer address)
1834 hmodule = get_module_for_address (address);
1835 if (hmodule == NULL)
1838 filename = g_win32_get_package_installation_directory_of_module (hmodule);
1839 retval = g_build_filename (filename, "share", NULL);
1845 const gchar * const *
1846 g_win32_get_system_data_dirs_for_module (void (*address_of_function)())
1850 static GHashTable *per_module_data_dirs = NULL;
1855 if (address_of_function)
1857 G_LOCK (g_utils_global);
1858 hmodule = get_module_for_address (address_of_function);
1859 if (hmodule != NULL)
1861 if (per_module_data_dirs == NULL)
1862 per_module_data_dirs = g_hash_table_new (NULL, NULL);
1865 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
1869 G_UNLOCK (g_utils_global);
1870 return (const gchar * const *) retval;
1876 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
1878 /* Documents and Settings\All Users\Application Data */
1879 p = get_special_folder (CSIDL_COMMON_APPDATA);
1881 g_array_append_val (data_dirs, p);
1883 /* Documents and Settings\All Users\Documents */
1884 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
1886 g_array_append_val (data_dirs, p);
1888 /* Using the above subfolders of Documents and Settings perhaps
1889 * makes sense from a Windows perspective.
1891 * But looking at the actual use cases of this function in GTK+
1892 * and GNOME software, what we really want is the "share"
1893 * subdirectory of the installation directory for the package
1894 * our caller is a part of.
1896 * The address_of_function parameter, if non-NULL, points to a
1897 * function in the calling module. Use that to determine that
1898 * module's installation folder, and use its "share" subfolder.
1900 * Additionally, also use the "share" subfolder of the installation
1901 * locations of GLib and the .exe file being run.
1903 * To guard against none of the above being what is really wanted,
1904 * callers of this function should have Win32-specific code to look
1905 * up their installation folder themselves, and handle a subfolder
1906 * "share" of it in the same way as the folders returned from this
1910 p = get_module_share_dir (address_of_function);
1912 g_array_append_val (data_dirs, p);
1914 if (glib_dll != NULL)
1916 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
1917 p = g_build_filename (glib_root, "share", NULL);
1919 g_array_append_val (data_dirs, p);
1923 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
1924 p = g_build_filename (exe_root, "share", NULL);
1926 g_array_append_val (data_dirs, p);
1929 retval = (gchar **) g_array_free (data_dirs, FALSE);
1931 if (address_of_function)
1933 if (hmodule != NULL)
1934 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
1935 G_UNLOCK (g_utils_global);
1938 return (const gchar * const *) retval;
1944 * g_get_system_data_dirs:
1946 * Returns an ordered list of base directories in which to access
1947 * system-wide application data.
1949 * On UNIX platforms this is determined using the mechanisms described in
1950 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1951 * XDG Base Directory Specification</ulink>
1952 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
1954 * On Windows the first elements in the list are the Application Data
1955 * and Documents folders for All Users. (These can be determined only
1956 * on Windows 2000 or later and are not present in the list on other
1957 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
1958 * CSIDL_COMMON_DOCUMENTS.
1960 * Then follows the "share" subfolder in the installation folder for
1961 * the package containing the DLL that calls this function, if it can
1964 * Finally the list contains the "share" subfolder in the installation
1965 * folder for GLib, and in the installation folder for the package the
1966 * application's .exe file belongs to.
1968 * The installation folders above are determined by looking up the
1969 * folder where the module (DLL or EXE) in question is located. If the
1970 * folder's name is "bin", its parent is used, otherwise the folder
1973 * Note that on Windows the returned list can vary depending on where
1974 * this function is called.
1976 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
1977 * not be modified or freed.
1980 const gchar * const *
1981 g_get_system_data_dirs (void)
1983 gchar **data_dir_vector;
1985 G_LOCK (g_utils_global);
1987 if (!g_system_data_dirs)
1990 data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
1992 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
1994 if (!data_dirs || !data_dirs[0])
1995 data_dirs = "/usr/local/share/:/usr/share/";
1997 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2000 g_system_data_dirs = data_dir_vector;
2003 data_dir_vector = g_system_data_dirs;
2005 G_UNLOCK (g_utils_global);
2007 return (const gchar * const *) data_dir_vector;
2011 * g_get_system_config_dirs:
2013 * Returns an ordered list of base directories in which to access
2014 * system-wide configuration information.
2016 * On UNIX platforms this is determined using the mechanisms described in
2017 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2018 * XDG Base Directory Specification</ulink>.
2019 * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2021 * On Windows is the directory that contains application data for all users.
2022 * A typical path is C:\Documents and Settings\All Users\Application Data.
2023 * This folder is used for application data that is not user specific.
2024 * For example, an application can store a spell-check dictionary, a database
2025 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2026 * This information will not roam and is available to anyone using the computer.
2028 * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
2029 * not be modified or freed.
2032 const gchar * const *
2033 g_get_system_config_dirs (void)
2035 gchar *conf_dirs, **conf_dir_vector;
2037 G_LOCK (g_utils_global);
2039 if (!g_system_config_dirs)
2042 conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2045 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2050 /* Return empty list */
2051 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2054 conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2056 if (!conf_dirs || !conf_dirs[0])
2057 conf_dirs = "/etc/xdg";
2059 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2062 g_system_config_dirs = conf_dir_vector;
2065 conf_dir_vector = g_system_config_dirs;
2066 G_UNLOCK (g_utils_global);
2068 return (const gchar * const *) conf_dir_vector;
2072 * g_nullify_pointer:
2073 * @nullify_location: the memory address of the pointer.
2075 * Set the pointer at the specified location to %NULL.
2078 g_nullify_pointer (gpointer *nullify_location)
2080 g_return_if_fail (nullify_location != NULL);
2082 *nullify_location = NULL;
2085 #define KILOBYTE_FACTOR (G_GOFFSET_CONSTANT (1000))
2086 #define MEGABYTE_FACTOR (KILOBYTE_FACTOR * KILOBYTE_FACTOR)
2087 #define GIGABYTE_FACTOR (MEGABYTE_FACTOR * KILOBYTE_FACTOR)
2088 #define TERABYTE_FACTOR (GIGABYTE_FACTOR * KILOBYTE_FACTOR)
2089 #define PETABYTE_FACTOR (TERABYTE_FACTOR * KILOBYTE_FACTOR)
2090 #define EXABYTE_FACTOR (PETABYTE_FACTOR * KILOBYTE_FACTOR)
2092 #define KIBIBYTE_FACTOR (G_GOFFSET_CONSTANT (1024))
2093 #define MEBIBYTE_FACTOR (KIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2094 #define GIBIBYTE_FACTOR (MEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2095 #define TEBIBYTE_FACTOR (GIBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2096 #define PEBIBYTE_FACTOR (TEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2097 #define EXBIBYTE_FACTOR (PEBIBYTE_FACTOR * KIBIBYTE_FACTOR)
2101 * @size: a size in bytes
2103 * Formats a size (for example the size of a file) into a human readable
2104 * string. Sizes are rounded to the nearest size prefix (kB, MB, GB)
2105 * and are displayed rounded to the nearest tenth. E.g. the file size
2106 * 3292528 bytes will be converted into the string "3.2 MB".
2108 * The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).
2110 * This string should be freed with g_free() when not needed any longer.
2112 * See g_format_size_full() for more options about how the size might be
2115 * Returns: a newly-allocated formatted string containing a human readable
2121 g_format_size (guint64 size)
2123 return g_format_size_full (size, G_FORMAT_SIZE_DEFAULT);
2128 * @G_FORMAT_SIZE_DEFAULT: behave the same as g_format_size()
2129 * @G_FORMAT_SIZE_LONG_FORMAT: include the exact number of bytes as part
2130 * of the returned string. For example, "45.6 kB (45,612 bytes)".
2131 * @G_FORMAT_SIZE_IEC_UNITS: use IEC (base 1024) units with "KiB"-style
2132 * suffixes. IEC units should only be used for reporting things with
2133 * a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
2134 * Network and storage sizes should be reported in the normal SI units.
2136 * Flags to modify the format of the string returned by g_format_size_full().
2140 * g_format_size_full:
2141 * @size: a size in bytes
2142 * @flags: #GFormatSizeFlags to modify the output
2146 * This function is similar to g_format_size() but allows for flags
2147 * that modify the output. See #GFormatSizeFlags.
2149 * Returns: a newly-allocated formatted string containing a human
2150 * readable file size
2155 g_format_size_full (guint64 size,
2156 GFormatSizeFlags flags)
2160 string = g_string_new (NULL);
2162 if (flags & G_FORMAT_SIZE_IEC_UNITS)
2164 if (size < KIBIBYTE_FACTOR)
2166 g_string_printf (string,
2167 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2169 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2172 else if (size < MEBIBYTE_FACTOR)
2173 g_string_printf (string, _("%.1f KiB"), (gdouble) size / (gdouble) KIBIBYTE_FACTOR);
2174 else if (size < GIBIBYTE_FACTOR)
2175 g_string_printf (string, _("%.1f MiB"), (gdouble) size / (gdouble) MEBIBYTE_FACTOR);
2177 else if (size < TEBIBYTE_FACTOR)
2178 g_string_printf (string, _("%.1f GiB"), (gdouble) size / (gdouble) GIBIBYTE_FACTOR);
2180 else if (size < PEBIBYTE_FACTOR)
2181 g_string_printf (string, _("%.1f TiB"), (gdouble) size / (gdouble) TEBIBYTE_FACTOR);
2183 else if (size < EXBIBYTE_FACTOR)
2184 g_string_printf (string, _("%.1f PiB"), (gdouble) size / (gdouble) PEBIBYTE_FACTOR);
2187 g_string_printf (string, _("%.1f EiB"), (gdouble) size / (gdouble) EXBIBYTE_FACTOR);
2191 if (size < KILOBYTE_FACTOR)
2193 g_string_printf (string,
2194 g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes", (guint) size),
2196 flags &= ~G_FORMAT_SIZE_LONG_FORMAT;
2199 else if (size < MEGABYTE_FACTOR)
2200 g_string_printf (string, _("%.1f kB"), (gdouble) size / (gdouble) KILOBYTE_FACTOR);
2202 else if (size < GIGABYTE_FACTOR)
2203 g_string_printf (string, _("%.1f MB"), (gdouble) size / (gdouble) MEGABYTE_FACTOR);
2205 else if (size < TERABYTE_FACTOR)
2206 g_string_printf (string, _("%.1f GB"), (gdouble) size / (gdouble) GIGABYTE_FACTOR);
2207 else if (size < PETABYTE_FACTOR)
2208 g_string_printf (string, _("%.1f TB"), (gdouble) size / (gdouble) TERABYTE_FACTOR);
2210 else if (size < EXABYTE_FACTOR)
2211 g_string_printf (string, _("%.1f PB"), (gdouble) size / (gdouble) PETABYTE_FACTOR);
2214 g_string_printf (string, _("%.1f EB"), (gdouble) size / (gdouble) EXABYTE_FACTOR);
2217 if (flags & G_FORMAT_SIZE_LONG_FORMAT)
2219 /* First problem: we need to use the number of bytes to decide on
2220 * the plural form that is used for display, but the number of
2221 * bytes potentially exceeds the size of a guint (which is what
2222 * ngettext() takes).
2224 * From a pragmatic standpoint, it seems that all known languages
2225 * base plural forms on one or both of the following:
2227 * - the lowest digits of the number
2229 * - if the number if greater than some small value
2231 * Here's how we fake it: Draw an arbitrary line at one thousand.
2232 * If the number is below that, then fine. If it is above it,
2233 * then we take the modulus of the number by one thousand (in
2234 * order to keep the lowest digits) and add one thousand to that
2235 * (in order to ensure that 1001 is not treated the same as 1).
2237 guint plural_form = size < 1000 ? size : size % 1000 + 1000;
2239 /* Second problem: we need to translate the string "%u byte" and
2240 * "%u bytes" for pluralisation, but the correct number format to
2241 * use for a gsize is different depending on which architecture
2244 * Solution: format the number separately and use "%s bytes" on
2247 const gchar *translated_format;
2248 gchar *formatted_number;
2250 /* Translators: the %s in "%s bytes" will always be replaced by a number. */
2251 translated_format = g_dngettext(GETTEXT_PACKAGE, "%s byte", "%s bytes", plural_form);
2252 /* XXX: Windows doesn't support the "'" format modifier, so we
2253 * must not use it there. Instead, just display the number
2254 * without separation. Bug #655336 is open until a solution is
2258 formatted_number = g_strdup_printf ("%'"G_GUINT64_FORMAT, size);
2260 formatted_number = g_strdup_printf ("%"G_GUINT64_FORMAT, size);
2263 g_string_append (string, " (");
2264 g_string_append_printf (string, translated_format, formatted_number);
2265 g_free (formatted_number);
2266 g_string_append (string, ")");
2269 return g_string_free (string, FALSE);
2273 * g_format_size_for_display:
2274 * @size: a size in bytes
2276 * Formats a size (for example the size of a file) into a human
2277 * readable string. Sizes are rounded to the nearest size prefix
2278 * (KB, MB, GB) and are displayed rounded to the nearest tenth.
2279 * E.g. the file size 3292528 bytes will be converted into the
2282 * The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
2284 * This string should be freed with g_free() when not needed any longer.
2286 * Returns: a newly-allocated formatted string containing a human
2287 * readable file size
2291 * Deprecated:2.30: This function is broken due to its use of SI
2292 * suffixes to denote IEC units. Use g_format_size() instead.
2295 g_format_size_for_display (goffset size)
2297 if (size < (goffset) KIBIBYTE_FACTOR)
2298 return g_strdup_printf (g_dngettext(GETTEXT_PACKAGE, "%u byte", "%u bytes",(guint) size), (guint) size);
2301 gdouble displayed_size;
2303 if (size < (goffset) MEBIBYTE_FACTOR)
2305 displayed_size = (gdouble) size / (gdouble) KIBIBYTE_FACTOR;
2306 return g_strdup_printf (_("%.1f KB"), displayed_size);
2308 else if (size < (goffset) GIBIBYTE_FACTOR)
2310 displayed_size = (gdouble) size / (gdouble) MEBIBYTE_FACTOR;
2311 return g_strdup_printf (_("%.1f MB"), displayed_size);
2313 else if (size < (goffset) TEBIBYTE_FACTOR)
2315 displayed_size = (gdouble) size / (gdouble) GIBIBYTE_FACTOR;
2316 return g_strdup_printf (_("%.1f GB"), displayed_size);
2318 else if (size < (goffset) PEBIBYTE_FACTOR)
2320 displayed_size = (gdouble) size / (gdouble) TEBIBYTE_FACTOR;
2321 return g_strdup_printf (_("%.1f TB"), displayed_size);
2323 else if (size < (goffset) EXBIBYTE_FACTOR)
2325 displayed_size = (gdouble) size / (gdouble) PEBIBYTE_FACTOR;
2326 return g_strdup_printf (_("%.1f PB"), displayed_size);
2330 displayed_size = (gdouble) size / (gdouble) EXBIBYTE_FACTOR;
2331 return g_strdup_printf (_("%.1f EB"), displayed_size);
2336 #if defined (G_OS_WIN32) && !defined (_WIN64)
2338 /* Binary compatibility versions. Not for newly compiled code. */
2340 #undef g_find_program_in_path
2343 g_find_program_in_path (const gchar *program)
2345 gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
2346 gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
2349 g_free (utf8_program);
2350 if (utf8_retval == NULL)
2352 retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
2353 g_free (utf8_retval);
2358 #undef g_get_user_name
2361 g_get_user_name (void)
2363 g_get_any_init_locked ();
2364 return g_user_name_cp;
2367 #undef g_get_real_name
2370 g_get_real_name (void)
2372 g_get_any_init_locked ();
2373 return g_real_name_cp;
2376 #undef g_get_home_dir
2379 g_get_home_dir (void)
2381 g_get_any_init_locked ();
2382 return g_home_dir_cp;
2385 #undef g_get_tmp_dir
2388 g_get_tmp_dir (void)
2390 g_get_any_init_locked ();
2391 return g_tmp_dir_cp;