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 "gfileutils.h"
65 #include "gprintfint.h"
67 #include "gthreadprivate.h"
68 #include "gtestutils.h"
70 #include "gstrfuncs.h"
73 #ifdef G_PLATFORM_WIN32
80 #define G_PATH_LENGTH MAXPATHLEN
81 #elif defined (PATH_MAX)
82 #define G_PATH_LENGTH PATH_MAX
83 #elif defined (_PC_PATH_MAX)
84 #define G_PATH_LENGTH sysconf(_PC_PATH_MAX)
86 #define G_PATH_LENGTH 2048
89 #ifdef G_PLATFORM_WIN32
90 # define STRICT /* Strict typing, please */
93 # ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
94 # define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
95 # define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
97 # include <lmcons.h> /* For UNLEN */
98 #endif /* G_PLATFORM_WIN32 */
103 /* older SDK (e.g. msvc 5.0) does not have these*/
104 # ifndef CSIDL_MYMUSIC
105 # define CSIDL_MYMUSIC 13
107 # ifndef CSIDL_MYVIDEO
108 # define CSIDL_MYVIDEO 14
110 # ifndef CSIDL_INTERNET_CACHE
111 # define CSIDL_INTERNET_CACHE 32
113 # ifndef CSIDL_COMMON_APPDATA
114 # define CSIDL_COMMON_APPDATA 35
116 # ifndef CSIDL_MYPICTURES
117 # define CSIDL_MYPICTURES 0x27
119 # ifndef CSIDL_COMMON_DOCUMENTS
120 # define CSIDL_COMMON_DOCUMENTS 46
122 # ifndef CSIDL_PROFILE
123 # define CSIDL_PROFILE 40
125 # include <process.h>
129 #include <CoreServices/CoreServices.h>
133 #include <langinfo.h>
136 const guint glib_major_version = GLIB_MAJOR_VERSION;
137 const guint glib_minor_version = GLIB_MINOR_VERSION;
138 const guint glib_micro_version = GLIB_MICRO_VERSION;
139 const guint glib_interface_age = GLIB_INTERFACE_AGE;
140 const guint glib_binary_age = GLIB_BINARY_AGE;
142 #ifdef G_PLATFORM_WIN32
144 static HMODULE glib_dll = NULL;
149 DllMain (HINSTANCE hinstDLL,
153 if (fdwReason == DLL_PROCESS_ATTACH)
162 _glib_get_dll_directory (void)
166 wchar_t wc_fn[MAX_PATH];
169 if (glib_dll == NULL)
173 /* This code is different from that in
174 * g_win32_get_package_installation_directory_of_module() in that
175 * here we return the actual folder where the GLib DLL is. We don't
176 * do the check for it being in a "bin" or "lib" subfolder and then
177 * returning the parent of that.
179 * In a statically built GLib, glib_dll will be NULL and we will
180 * thus look up the application's .exe file's location.
182 if (!GetModuleFileNameW (glib_dll, wc_fn, MAX_PATH))
185 retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
187 p = strrchr (retval, G_DIR_SEPARATOR);
201 * glib_check_version:
202 * @required_major: the required major version.
203 * @required_minor: the required minor version.
204 * @required_micro: the required micro version.
206 * Checks that the GLib library in use is compatible with the
207 * given version. Generally you would pass in the constants
208 * #GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION
209 * as the three arguments to this function; that produces
210 * a check that the library in use is compatible with
211 * the version of GLib the application or module was compiled
214 * Compatibility is defined by two things: first the version
215 * of the running library is newer than the version
216 * @required_major.required_minor.@required_micro. Second
217 * the running library must be binary compatible with the
218 * version @required_major.required_minor.@required_micro
219 * (same major version.)
221 * Return value: %NULL if the GLib library is compatible with the
222 * given version, or a string describing the version mismatch.
223 * The returned string is owned by GLib and must not be modified
229 glib_check_version (guint required_major,
230 guint required_minor,
231 guint required_micro)
233 gint glib_effective_micro = 100 * GLIB_MINOR_VERSION + GLIB_MICRO_VERSION;
234 gint required_effective_micro = 100 * required_minor + required_micro;
236 if (required_major > GLIB_MAJOR_VERSION)
237 return "GLib version too old (major mismatch)";
238 if (required_major < GLIB_MAJOR_VERSION)
239 return "GLib version too new (major mismatch)";
240 if (required_effective_micro < glib_effective_micro - GLIB_BINARY_AGE)
241 return "GLib version too new (micro mismatch)";
242 if (required_effective_micro > glib_effective_micro)
243 return "GLib version too old (micro mismatch)";
247 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
250 * @dest: the destination address to copy the bytes to.
251 * @src: the source address to copy the bytes from.
252 * @len: the number of bytes to copy.
254 * Copies a block of memory @len bytes long, from @src to @dest.
255 * The source and destination areas may overlap.
257 * In order to use this function, you must include
258 * <filename>string.h</filename> yourself, because this macro will
259 * typically simply resolve to memmove() and GLib does not include
260 * <filename>string.h</filename> for you.
263 g_memmove (gpointer dest,
267 gchar* destptr = dest;
268 const gchar* srcptr = src;
269 if (src + len < dest || dest + len < src)
271 bcopy (src, dest, len);
274 else if (dest <= src)
277 *(destptr++) = *(srcptr++);
284 *(--destptr) = *(--srcptr);
287 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
295 * @func: the function to call on normal program termination.
297 * Specifies a function to be called at normal program termination.
299 * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
300 * macro that maps to a call to the atexit() function in the C
301 * library. This means that in case the code that calls g_atexit(),
302 * i.e. atexit(), is in a DLL, the function will be called when the
303 * DLL is detached from the program. This typically makes more sense
304 * than that the function is called when the GLib DLL is detached,
305 * which happened earlier when g_atexit() was a function in the GLib
308 * The behaviour of atexit() in the context of dynamically loaded
309 * modules is not formally specified and varies wildly.
311 * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
312 * loaded module which is unloaded before the program terminates might
313 * well cause a crash at program exit.
315 * Some POSIX systems implement atexit() like Windows, and have each
316 * dynamically loaded module maintain an own atexit chain that is
317 * called when the module is unloaded.
319 * On other POSIX systems, before a dynamically loaded module is
320 * unloaded, the registered atexit functions (if any) residing in that
321 * module are called, regardless where the code that registered them
322 * resided. This is presumably the most robust approach.
324 * As can be seen from the above, for portability it's best to avoid
325 * calling g_atexit() (or atexit()) except in the main executable of a
329 g_atexit (GVoidFunc func)
332 const gchar *error = NULL;
334 /* keep this in sync with glib.h */
336 #ifdef G_NATIVE_ATEXIT
337 result = ATEXIT (func);
339 error = g_strerror (errno);
340 #elif defined (HAVE_ATEXIT)
341 # ifdef NeXT /* @#%@! NeXTStep */
342 result = !atexit ((void (*)(void)) func);
344 error = g_strerror (errno);
346 result = atexit ((void (*)(void)) func);
348 error = g_strerror (errno);
350 #elif defined (HAVE_ON_EXIT)
351 result = on_exit ((void (*)(int, void *)) func, NULL);
353 error = g_strerror (errno);
356 error = "no implementation";
357 #endif /* G_NATIVE_ATEXIT */
360 g_error ("Could not register atexit() function: %s", error);
363 /* Based on execvp() from GNU Libc.
364 * Some of this code is cut-and-pasted into gspawn.c
368 my_strchrnul (const gchar *str,
371 gchar *p = (gchar*)str;
372 while (*p && (*p != c))
380 static gchar *inner_find_program_in_path (const gchar *program);
383 g_find_program_in_path (const gchar *program)
385 const gchar *last_dot = strrchr (program, '.');
387 if (last_dot == NULL ||
388 strchr (last_dot, '\\') != NULL ||
389 strchr (last_dot, '/') != NULL)
391 const gint program_length = strlen (program);
392 gchar *pathext = g_build_path (";",
393 ".exe;.cmd;.bat;.com",
394 g_getenv ("PATHEXT"),
397 gchar *decorated_program;
403 gchar *q = my_strchrnul (p, ';');
405 decorated_program = g_malloc (program_length + (q-p) + 1);
406 memcpy (decorated_program, program, program_length);
407 memcpy (decorated_program+program_length, p, q-p);
408 decorated_program [program_length + (q-p)] = '\0';
410 retval = inner_find_program_in_path (decorated_program);
411 g_free (decorated_program);
419 } while (*p++ != '\0');
424 return inner_find_program_in_path (program);
430 * g_find_program_in_path:
431 * @program: a program name in the GLib file name encoding
433 * Locates the first executable named @program in the user's path, in the
434 * same way that execvp() would locate it. Returns an allocated string
435 * with the absolute path name, or %NULL if the program is not found in
436 * the path. If @program is already an absolute path, returns a copy of
437 * @program if @program exists and is executable, and %NULL otherwise.
439 * On Windows, if @program does not have a file type suffix, tries
440 * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
441 * the <envar>PATHEXT</envar> environment variable.
443 * On Windows, it looks for the file in the same way as CreateProcess()
444 * would. This means first in the directory where the executing
445 * program was loaded from, then in the current directory, then in the
446 * Windows 32-bit system directory, then in the Windows directory, and
447 * finally in the directories in the <envar>PATH</envar> environment
448 * variable. If the program is found, the return value contains the
449 * full name including the type suffix.
451 * Return value: absolute path, or %NULL
455 inner_find_program_in_path (const gchar *program)
458 g_find_program_in_path (const gchar *program)
461 const gchar *path, *p;
462 gchar *name, *freeme;
464 const gchar *path_copy;
465 gchar *filename = NULL, *appdir = NULL;
466 gchar *sysdir = NULL, *windir = NULL;
468 wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
474 g_return_val_if_fail (program != NULL, NULL);
476 /* If it is an absolute path, or a relative path including subdirectories,
477 * don't look in PATH.
479 if (g_path_is_absolute (program)
480 || strchr (program, G_DIR_SEPARATOR) != NULL
482 || strchr (program, '/') != NULL
486 if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
487 !g_file_test (program, G_FILE_TEST_IS_DIR))
488 return g_strdup (program);
493 path = g_getenv ("PATH");
494 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
497 /* There is no `PATH' in the environment. The default
498 * search path in GNU libc is the current directory followed by
499 * the path `confstr' returns for `_CS_PATH'.
502 /* In GLib we put . last, for security, and don't use the
503 * unportable confstr(); UNIX98 does not actually specify
504 * what to search if PATH is unset. POSIX may, dunno.
507 path = "/bin:/usr/bin:.";
510 n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
511 if (n > 0 && n < MAXPATHLEN)
512 filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
514 n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
515 if (n > 0 && n < MAXPATHLEN)
516 sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
518 n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
519 if (n > 0 && n < MAXPATHLEN)
520 windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
524 appdir = g_path_get_dirname (filename);
528 path = g_strdup (path);
532 const gchar *tem = path;
533 path = g_strconcat (windir, ";", path, NULL);
534 g_free ((gchar *) tem);
540 const gchar *tem = path;
541 path = g_strconcat (sysdir, ";", path, NULL);
542 g_free ((gchar *) tem);
547 const gchar *tem = path;
548 path = g_strconcat (".;", path, NULL);
549 g_free ((gchar *) tem);
554 const gchar *tem = path;
555 path = g_strconcat (appdir, ";", path, NULL);
556 g_free ((gchar *) tem);
563 len = strlen (program) + 1;
564 pathlen = strlen (path);
565 freeme = name = g_malloc (pathlen + len + 1);
567 /* Copy the file name at the top, including '\0' */
568 memcpy (name + pathlen + 1, program, len);
569 name = name + pathlen;
570 /* And add the slash before the filename */
571 *name = G_DIR_SEPARATOR;
579 p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
582 /* Two adjacent colons, or a colon at the beginning or the end
583 * of `PATH' means to search the current directory.
587 startp = memcpy (name - (p - path), path, p - path);
589 if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
590 !g_file_test (startp, G_FILE_TEST_IS_DIR))
593 ret = g_strdup (startp);
596 g_free ((gchar *) path_copy);
601 while (*p++ != '\0');
605 g_free ((gchar *) path_copy);
612 debug_key_matches (const gchar *key,
616 for (; length; length--, key++, token++)
618 char k = (*key == '_') ? '-' : tolower (*key );
619 char t = (*token == '_') ? '-' : tolower (*token);
629 * g_parse_debug_string:
630 * @string: a list of debug options separated by colons, spaces, or
632 * @keys: pointer to an array of #GDebugKey which associate
633 * strings with bit flags.
634 * @nkeys: the number of #GDebugKey<!-- -->s in the array.
636 * Parses a string containing debugging options
637 * into a %guint containing bit flags. This is used
638 * within GDK and GTK+ to parse the debug options passed on the
639 * command line or through environment variables.
641 * If @string is equal to "all", all flags are set. If @string
642 * is equal to "help", all the available keys in @keys are printed
643 * out to standard error.
645 * Returns: the combined set of bit flags.
648 g_parse_debug_string (const gchar *string,
649 const GDebugKey *keys,
658 /* this function is used by gmem.c/gslice.c initialization code,
659 * so introducing malloc dependencies here would require adaptions
660 * of those code portions.
663 if (!g_ascii_strcasecmp (string, "all"))
665 for (i=0; i<nkeys; i++)
666 result |= keys[i].value;
668 else if (!g_ascii_strcasecmp (string, "help"))
670 /* using stdio directly for the reason stated above */
671 fprintf (stderr, "Supported debug values: ");
672 for (i=0; i<nkeys; i++)
673 fprintf (stderr, " %s", keys[i].key);
674 fprintf (stderr, "\n");
678 const gchar *p = string;
683 q = strpbrk (p, ":;, \t");
687 for (i = 0; i < nkeys; i++)
688 if (debug_key_matches (keys[i].key, p, q - p))
689 result |= keys[i].value;
702 * @file_name: the name of the file.
704 * Gets the name of the file without any leading directory components.
705 * It returns a pointer into the given file name string.
707 * Return value: the name of the file without any leading directory components.
709 * Deprecated:2.2: Use g_path_get_basename() instead, but notice that
710 * g_path_get_basename() allocates new memory for the returned string, unlike
711 * this function which returns a pointer into the argument.
713 G_CONST_RETURN gchar*
714 g_basename (const gchar *file_name)
716 register gchar *base;
718 g_return_val_if_fail (file_name != NULL, NULL);
720 base = strrchr (file_name, G_DIR_SEPARATOR);
724 gchar *q = strrchr (file_name, '/');
725 if (base == NULL || (q != NULL && q > base))
734 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
735 return (gchar*) file_name + 2;
736 #endif /* G_OS_WIN32 */
738 return (gchar*) file_name;
742 * g_path_get_basename:
743 * @file_name: the name of the file.
745 * Gets the last component of the filename. If @file_name ends with a
746 * directory separator it gets the component before the last slash. If
747 * @file_name consists only of directory separators (and on Windows,
748 * possibly a drive letter), a single separator is returned. If
749 * @file_name is empty, it gets ".".
751 * Return value: a newly allocated string containing the last component of
755 g_path_get_basename (const gchar *file_name)
757 register gssize base;
758 register gssize last_nonslash;
762 g_return_val_if_fail (file_name != NULL, NULL);
764 if (file_name[0] == '\0')
766 return g_strdup (".");
768 last_nonslash = strlen (file_name) - 1;
770 while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
773 if (last_nonslash == -1)
774 /* string only containing slashes */
775 return g_strdup (G_DIR_SEPARATOR_S);
778 if (last_nonslash == 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
779 /* string only containing slashes and a drive */
780 return g_strdup (G_DIR_SEPARATOR_S);
781 #endif /* G_OS_WIN32 */
783 base = last_nonslash;
785 while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
789 if (base == -1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
791 #endif /* G_OS_WIN32 */
793 len = last_nonslash - base;
794 retval = g_malloc (len + 1);
795 memcpy (retval, file_name + base + 1, len);
801 * g_path_is_absolute:
802 * @file_name: a file name.
804 * Returns %TRUE if the given @file_name is an absolute file name.
805 * Note that this is a somewhat vague concept on Windows.
807 * On POSIX systems, an absolute file name is well-defined. It always
808 * starts from the single root directory. For example "/usr/local".
810 * On Windows, the concepts of current drive and drive-specific
811 * current directory introduce vagueness. This function interprets as
812 * an absolute file name one that either begins with a directory
813 * separator such as "\Users\tml" or begins with the root on a drive,
814 * for example "C:\Windows". The first case also includes UNC paths
815 * such as "\\myserver\docs\foo". In all cases, either slashes or
816 * backslashes are accepted.
818 * Note that a file name relative to the current drive root does not
819 * truly specify a file uniquely over time and across processes, as
820 * the current drive is a per-process value and can be changed.
822 * File names relative the current directory on some specific drive,
823 * such as "D:foo/bar", are not interpreted as absolute by this
824 * function, but they obviously are not relative to the normal current
825 * directory as returned by getcwd() or g_get_current_dir()
826 * either. Such paths should be avoided, or need to be handled using
827 * Windows-specific code.
829 * Returns: %TRUE if @file_name is absolute.
832 g_path_is_absolute (const gchar *file_name)
834 g_return_val_if_fail (file_name != NULL, FALSE);
836 if (G_IS_DIR_SEPARATOR (file_name[0]))
840 /* Recognize drive letter on native Windows */
841 if (g_ascii_isalpha (file_name[0]) &&
842 file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
844 #endif /* G_OS_WIN32 */
851 * @file_name: a file name.
853 * Returns a pointer into @file_name after the root component, i.e. after
854 * the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute
855 * path it returns %NULL.
857 * Returns: a pointer into @file_name after the root component.
859 G_CONST_RETURN gchar*
860 g_path_skip_root (const gchar *file_name)
862 g_return_val_if_fail (file_name != NULL, NULL);
864 #ifdef G_PLATFORM_WIN32
865 /* Skip \\server\share or //server/share */
866 if (G_IS_DIR_SEPARATOR (file_name[0]) &&
867 G_IS_DIR_SEPARATOR (file_name[1]) &&
869 !G_IS_DIR_SEPARATOR (file_name[2]))
873 p = strchr (file_name + 2, G_DIR_SEPARATOR);
876 gchar *q = strchr (file_name + 2, '/');
877 if (p == NULL || (q != NULL && q < p))
887 while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
890 /* Possibly skip a backslash after the share name */
891 if (G_IS_DIR_SEPARATOR (file_name[0]))
894 return (gchar *)file_name;
899 /* Skip initial slashes */
900 if (G_IS_DIR_SEPARATOR (file_name[0]))
902 while (G_IS_DIR_SEPARATOR (file_name[0]))
904 return (gchar *)file_name;
909 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
910 return (gchar *)file_name + 3;
917 * g_path_get_dirname:
918 * @file_name: the name of the file.
920 * Gets the directory components of a file name. If the file name has no
921 * directory components "." is returned. The returned string should be
922 * freed when no longer needed.
924 * Returns: the directory components of the file.
927 g_path_get_dirname (const gchar *file_name)
929 register gchar *base;
932 g_return_val_if_fail (file_name != NULL, NULL);
934 base = strrchr (file_name, G_DIR_SEPARATOR);
937 gchar *q = strrchr (file_name, '/');
938 if (base == NULL || (q != NULL && q > base))
945 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
947 gchar drive_colon_dot[4];
949 drive_colon_dot[0] = file_name[0];
950 drive_colon_dot[1] = ':';
951 drive_colon_dot[2] = '.';
952 drive_colon_dot[3] = '\0';
954 return g_strdup (drive_colon_dot);
957 return g_strdup (".");
960 while (base > file_name && G_IS_DIR_SEPARATOR (*base))
964 /* base points to the char before the last slash.
966 * In case file_name is the root of a drive (X:\) or a child of the
967 * root of a drive (X:\foo), include the slash.
969 * In case file_name is the root share of an UNC path
970 * (\\server\share), add a slash, returning \\server\share\ .
972 * In case file_name is a direct child of a share in an UNC path
973 * (\\server\share\foo), include the slash after the share name,
974 * returning \\server\share\ .
976 if (base == file_name + 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
978 else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
979 G_IS_DIR_SEPARATOR (file_name[1]) &&
981 !G_IS_DIR_SEPARATOR (file_name[2]) &&
982 base >= file_name + 2)
984 const gchar *p = file_name + 2;
985 while (*p && !G_IS_DIR_SEPARATOR (*p))
989 len = (guint) strlen (file_name) + 1;
990 base = g_new (gchar, len + 1);
991 strcpy (base, file_name);
992 base[len-1] = G_DIR_SEPARATOR;
996 if (G_IS_DIR_SEPARATOR (*p))
999 while (*p && !G_IS_DIR_SEPARATOR (*p))
1007 len = (guint) 1 + base - file_name;
1009 base = g_new (gchar, len + 1);
1010 g_memmove (base, file_name, len);
1017 * g_get_current_dir:
1019 * Gets the current directory.
1020 * The returned string should be freed when no longer needed. The encoding
1021 * of the returned string is system defined. On Windows, it is always UTF-8.
1023 * Returns: the current directory.
1026 g_get_current_dir (void)
1031 wchar_t dummy[2], *wdir;
1034 len = GetCurrentDirectoryW (2, dummy);
1035 wdir = g_new (wchar_t, len);
1037 if (GetCurrentDirectoryW (len, wdir) == len - 1)
1038 dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
1043 dir = g_strdup ("\\");
1049 gchar *buffer = NULL;
1051 static gulong max_len = 0;
1054 max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
1056 /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
1057 * and, if that wasn't bad enough, hangs in doing so.
1059 #if (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
1060 buffer = g_new (gchar, max_len + 1);
1062 dir = getwd (buffer);
1063 #else /* !sun || !HAVE_GETCWD */
1064 while (max_len < G_MAXULONG / 2)
1067 buffer = g_new (gchar, max_len + 1);
1069 dir = getcwd (buffer, max_len);
1071 if (dir || errno != ERANGE)
1076 #endif /* !sun || !HAVE_GETCWD */
1078 if (!dir || !*buffer)
1080 /* hm, should we g_error() out here?
1081 * this can happen if e.g. "./" has mode \0000
1083 buffer[0] = G_DIR_SEPARATOR;
1087 dir = g_strdup (buffer);
1096 * @variable: the environment variable to get, in the GLib file name encoding.
1098 * Returns the value of an environment variable. The name and value
1099 * are in the GLib file name encoding. On UNIX, this means the actual
1100 * bytes which might or might not be in some consistent character set
1101 * and encoding. On Windows, it is in UTF-8. On Windows, in case the
1102 * environment variable's value contains references to other
1103 * environment variables, they are expanded.
1105 * Return value: the value of the environment variable, or %NULL if
1106 * the environment variable is not found. The returned string may be
1107 * overwritten by the next call to g_getenv(), g_setenv() or
1110 G_CONST_RETURN gchar*
1111 g_getenv (const gchar *variable)
1115 g_return_val_if_fail (variable != NULL, NULL);
1117 return getenv (variable);
1119 #else /* G_OS_WIN32 */
1123 wchar_t dummy[2], *wname, *wvalue;
1126 g_return_val_if_fail (variable != NULL, NULL);
1127 g_return_val_if_fail (g_utf8_validate (variable, -1, NULL), NULL);
1129 /* On Windows NT, it is relatively typical that environment
1130 * variables contain references to other environment variables. If
1131 * so, use ExpandEnvironmentStrings(). (In an ideal world, such
1132 * environment variables would be stored in the Registry as
1133 * REG_EXPAND_SZ type values, and would then get automatically
1134 * expanded before a program sees them. But there is broken software
1135 * that stores environment variables as REG_SZ values even if they
1136 * contain references to other environment variables.)
1139 wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1141 len = GetEnvironmentVariableW (wname, dummy, 2);
1151 wvalue = g_new (wchar_t, len);
1153 if (GetEnvironmentVariableW (wname, wvalue, len) != len - 1)
1160 if (wcschr (wvalue, L'%') != NULL)
1162 wchar_t *tem = wvalue;
1164 len = ExpandEnvironmentStringsW (wvalue, dummy, 2);
1168 wvalue = g_new (wchar_t, len);
1170 if (ExpandEnvironmentStringsW (tem, wvalue, len) != len)
1180 value = g_utf16_to_utf8 (wvalue, -1, NULL, NULL, NULL);
1185 quark = g_quark_from_string (value);
1188 return g_quark_to_string (quark);
1190 #endif /* G_OS_WIN32 */
1193 /* _g_getenv_nomalloc
1194 * this function does a getenv() without doing any kind of allocation
1195 * through glib. it's suitable for chars <= 127 only (both, for the
1196 * variable name and the contents) and for contents < 1024 chars in
1197 * length. also, it aliases "" to a NULL return value.
1200 _g_getenv_nomalloc (const gchar *variable,
1203 const gchar *retval = getenv (variable);
1204 if (retval && retval[0])
1206 gint l = strlen (retval);
1209 strncpy (buffer, retval, l);
1219 * @variable: the environment variable to set, must not contain '='.
1220 * @value: the value for to set the variable to.
1221 * @overwrite: whether to change the variable if it already exists.
1223 * Sets an environment variable. Both the variable's name and value
1224 * should be in the GLib file name encoding. On UNIX, this means that
1225 * they can be any sequence of bytes. On Windows, they should be in
1228 * Note that on some systems, when variables are overwritten, the memory
1229 * used for the previous variables and its value isn't reclaimed.
1231 * Returns: %FALSE if the environment variable couldn't be set.
1236 g_setenv (const gchar *variable,
1247 g_return_val_if_fail (variable != NULL, FALSE);
1248 g_return_val_if_fail (strchr (variable, '=') == NULL, FALSE);
1251 result = setenv (variable, value, overwrite);
1253 if (!overwrite && getenv (variable) != NULL)
1256 /* This results in a leak when you overwrite existing
1257 * settings. It would be fairly easy to fix this by keeping
1258 * our own parallel array or hash table.
1260 string = g_strconcat (variable, "=", value, NULL);
1261 result = putenv (string);
1265 #else /* G_OS_WIN32 */
1268 wchar_t *wname, *wvalue, *wassignment;
1271 g_return_val_if_fail (variable != NULL, FALSE);
1272 g_return_val_if_fail (strchr (variable, '=') == NULL, FALSE);
1273 g_return_val_if_fail (g_utf8_validate (variable, -1, NULL), FALSE);
1274 g_return_val_if_fail (g_utf8_validate (value, -1, NULL), FALSE);
1276 if (!overwrite && g_getenv (variable) != NULL)
1279 /* We want to (if possible) set both the environment variable copy
1280 * kept by the C runtime and the one kept by the system.
1282 * We can't use only the C runtime's putenv or _wputenv() as that
1283 * won't work for arbitrary Unicode strings in a "non-Unicode" app
1284 * (with main() and not wmain()). In a "main()" app the C runtime
1285 * initializes the C runtime's environment table by converting the
1286 * real (wide char) environment variables to system codepage, thus
1287 * breaking those that aren't representable in the system codepage.
1289 * As the C runtime's putenv() will also set the system copy, we do
1290 * the putenv() first, then call SetEnvironmentValueW ourselves.
1293 wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1294 wvalue = g_utf8_to_utf16 (value, -1, NULL, NULL, NULL);
1295 tem = g_strconcat (variable, "=", value, NULL);
1296 wassignment = g_utf8_to_utf16 (tem, -1, NULL, NULL, NULL);
1299 _wputenv (wassignment);
1300 g_free (wassignment);
1302 retval = (SetEnvironmentVariableW (wname, wvalue) != 0);
1309 #endif /* G_OS_WIN32 */
1312 #ifdef HAVE__NSGETENVIRON
1313 #define environ (*_NSGetEnviron())
1314 #elif !defined(G_OS_WIN32)
1316 /* According to the Single Unix Specification, environ is not in
1317 * any system header, although unistd.h often declares it.
1319 extern char **environ;
1324 * @variable: the environment variable to remove, must not contain '='.
1326 * Removes an environment variable from the environment.
1328 * Note that on some systems, when variables are overwritten, the memory
1329 * used for the previous variables and its value isn't reclaimed.
1330 * Furthermore, this function can't be guaranteed to operate in a
1336 g_unsetenv (const gchar *variable)
1340 #ifdef HAVE_UNSETENV
1341 g_return_if_fail (variable != NULL);
1342 g_return_if_fail (strchr (variable, '=') == NULL);
1344 unsetenv (variable);
1345 #else /* !HAVE_UNSETENV */
1349 g_return_if_fail (variable != NULL);
1350 g_return_if_fail (strchr (variable, '=') == NULL);
1352 len = strlen (variable);
1354 /* Mess directly with the environ array.
1355 * This seems to be the only portable way to do this.
1357 * Note that we remove *all* environment entries for
1358 * the variable name, not just the first.
1363 if (strncmp (*e, variable, len) != 0 || (*e)[len] != '=')
1371 #endif /* !HAVE_UNSETENV */
1373 #else /* G_OS_WIN32 */
1375 wchar_t *wname, *wassignment;
1378 g_return_if_fail (variable != NULL);
1379 g_return_if_fail (strchr (variable, '=') == NULL);
1380 g_return_if_fail (g_utf8_validate (variable, -1, NULL));
1382 wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1383 tem = g_strconcat (variable, "=", NULL);
1384 wassignment = g_utf8_to_utf16 (tem, -1, NULL, NULL, NULL);
1387 _wputenv (wassignment);
1388 g_free (wassignment);
1390 SetEnvironmentVariableW (wname, NULL);
1394 #endif /* G_OS_WIN32 */
1400 * Gets the names of all variables set in the environment.
1402 * Returns: a %NULL-terminated list of strings which must be freed
1403 * with g_strfreev().
1405 * Programs that want to be portable to Windows should typically use
1406 * this function and g_getenv() instead of using the environ array
1407 * from the C library directly. On Windows, the strings in the environ
1408 * array are in system codepage encoding, while in most of the typical
1409 * use cases for environment variables in GLib-using programs you want
1410 * the UTF-8 encoding that this function and g_getenv() provide.
1418 gchar **result, *eq;
1421 len = g_strv_length (environ);
1422 result = g_new0 (gchar *, len + 1);
1425 for (i = 0; i < len; i++)
1427 eq = strchr (environ[i], '=');
1429 result[j++] = g_strndup (environ[i], eq - environ[i]);
1436 gchar **result, *eq;
1440 p = (wchar_t *) GetEnvironmentStringsW ();
1446 q += wcslen (q) + 1;
1450 result = g_new0 (gchar *, len + 1);
1456 result[j] = g_utf16_to_utf8 (q, -1, NULL, NULL, NULL);
1457 if (result[j] != NULL)
1459 eq = strchr (result[j], '=');
1460 if (eq && eq > result[j])
1468 q += wcslen (q) + 1;
1471 FreeEnvironmentStringsW (p);
1480 * Gets the list of environment variables for the current process. The
1481 * list is %NULL terminated and each item in the list is of the form
1484 * This is equivalent to direct access to the 'environ' global variable,
1487 * The return value is freshly allocated and it should be freed with
1488 * g_strfreev() when it is no longer needed.
1490 * Returns: the list of environment variables
1495 g_get_environ (void)
1498 return g_strdupv (environ);
1504 strings = GetEnvironmentStringsW ();
1505 for (n = 0; strings[n]; n += wcslen (strings + n) + 1);
1506 result = g_new (char *, n + 1);
1507 for (i = 0; strings[i]; i += wcslen (strings + i) + 1)
1508 result[i] = g_utf16_to_utf8 (strings + i, -1, NULL, NULL, NULL);
1509 FreeEnvironmentStringsW (strings);
1516 G_LOCK_DEFINE_STATIC (g_utils_global);
1518 static gchar *g_tmp_dir = NULL;
1519 static gchar *g_user_name = NULL;
1520 static gchar *g_real_name = NULL;
1521 static gchar *g_home_dir = NULL;
1522 static gchar *g_host_name = NULL;
1525 /* System codepage versions of the above, kept at file level so that they,
1526 * too, are produced only once.
1528 static gchar *g_tmp_dir_cp = NULL;
1529 static gchar *g_user_name_cp = NULL;
1530 static gchar *g_real_name_cp = NULL;
1531 static gchar *g_home_dir_cp = NULL;
1534 static gchar *g_user_data_dir = NULL;
1535 static gchar **g_system_data_dirs = NULL;
1536 static gchar *g_user_cache_dir = NULL;
1537 static gchar *g_user_config_dir = NULL;
1538 static gchar **g_system_config_dirs = NULL;
1540 static gchar **g_user_special_dirs = NULL;
1542 /* fifteen minutes of fame for everybody */
1543 #define G_USER_DIRS_EXPIRE 15 * 60
1548 get_special_folder (int csidl)
1550 wchar_t path[MAX_PATH+1];
1552 LPITEMIDLIST pidl = NULL;
1554 gchar *retval = NULL;
1556 hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
1559 b = SHGetPathFromIDListW (pidl, path);
1561 retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
1562 CoTaskMemFree (pidl);
1568 get_windows_directory_root (void)
1570 wchar_t wwindowsdir[MAX_PATH];
1572 if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
1574 /* Usually X:\Windows, but in terminal server environments
1575 * might be an UNC path, AFAIK.
1577 char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
1580 if (windowsdir == NULL)
1581 return g_strdup ("C:\\");
1583 p = (char *) g_path_skip_root (windowsdir);
1584 if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
1590 return g_strdup ("C:\\");
1595 /* HOLDS: g_utils_global_lock */
1597 g_get_any_init_do (void)
1599 gchar hostname[100];
1601 g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
1602 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
1603 g_tmp_dir = g_strdup (g_getenv ("TMP"));
1604 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
1605 g_tmp_dir = g_strdup (g_getenv ("TEMP"));
1608 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
1609 g_tmp_dir = get_windows_directory_root ();
1612 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
1615 g_tmp_dir = g_strdup (P_tmpdir);
1616 k = strlen (g_tmp_dir);
1617 if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
1618 g_tmp_dir[k - 1] = '\0';
1622 if (g_tmp_dir == NULL || *g_tmp_dir == '\0')
1624 g_tmp_dir = g_strdup ("/tmp");
1626 #endif /* !G_OS_WIN32 */
1629 /* We check $HOME first for Win32, though it is a last resort for Unix
1630 * where we prefer the results of getpwuid().
1632 g_home_dir = g_strdup (g_getenv ("HOME"));
1634 /* Only believe HOME if it is an absolute path and exists */
1637 if (!(g_path_is_absolute (g_home_dir) &&
1638 g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
1640 g_free (g_home_dir);
1645 /* In case HOME is Unix-style (it happens), convert it to
1651 while ((p = strchr (g_home_dir, '/')) != NULL)
1657 /* USERPROFILE is probably the closest equivalent to $HOME? */
1658 if (g_getenv ("USERPROFILE") != NULL)
1659 g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
1663 g_home_dir = get_special_folder (CSIDL_PROFILE);
1666 g_home_dir = get_windows_directory_root ();
1667 #endif /* G_OS_WIN32 */
1671 struct passwd *pw = NULL;
1672 gpointer buffer = NULL;
1676 # if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
1678 # ifdef _SC_GETPW_R_SIZE_MAX
1679 /* This reurns the maximum length */
1680 glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
1684 # else /* _SC_GETPW_R_SIZE_MAX */
1686 # endif /* _SC_GETPW_R_SIZE_MAX */
1688 logname = (gchar *) g_getenv ("LOGNAME");
1693 /* we allocate 6 extra bytes to work around a bug in
1694 * Mac OS < 10.3. See #156446
1696 buffer = g_malloc (bufsize + 6);
1699 # ifdef HAVE_POSIX_GETPWUID_R
1701 error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
1702 if (!pw || (pw->pw_uid != getuid ())) {
1703 /* LOGNAME is lying, fall back to looking up the uid */
1704 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1707 error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1709 error = error < 0 ? errno : error;
1710 # else /* HAVE_NONPOSIX_GETPWUID_R */
1711 /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
1712 # if defined(_AIX) || defined(__hpux)
1713 error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1714 pw = error == 0 ? &pwd : NULL;
1717 pw = getpwnam_r (logname, &pwd, buffer, bufsize);
1718 if (!pw || (pw->pw_uid != getuid ())) {
1719 /* LOGNAME is lying, fall back to looking up the uid */
1720 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1723 pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1725 error = pw ? 0 : errno;
1727 # endif /* HAVE_NONPOSIX_GETPWUID_R */
1731 /* we bail out prematurely if the user id can't be found
1732 * (should be pretty rare case actually), or if the buffer
1733 * should be sufficiently big and lookups are still not
1736 if (error == 0 || error == ENOENT)
1738 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
1739 (gulong) getuid ());
1742 if (bufsize > 32 * 1024)
1744 g_warning ("getpwuid_r(): failed due to: %s.",
1745 g_strerror (error));
1753 # endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
1758 pw = getpwuid (getuid ());
1763 g_user_name = g_strdup (pw->pw_name);
1765 if (pw->pw_gecos && *pw->pw_gecos != '\0')
1767 gchar **gecos_fields;
1770 /* split the gecos field and substitute '&' */
1771 gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
1772 name_parts = g_strsplit (gecos_fields[0], "&", 0);
1773 pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
1774 g_real_name = g_strjoinv (pw->pw_name, name_parts);
1775 g_strfreev (gecos_fields);
1776 g_strfreev (name_parts);
1780 g_home_dir = g_strdup (pw->pw_dir);
1785 #else /* !HAVE_PWD_H */
1789 guint len = UNLEN+1;
1790 wchar_t buffer[UNLEN+1];
1792 if (GetUserNameW (buffer, (LPDWORD) &len))
1794 g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
1795 g_real_name = g_strdup (g_user_name);
1798 #endif /* G_OS_WIN32 */
1800 #endif /* !HAVE_PWD_H */
1804 g_home_dir = g_strdup (g_getenv ("HOME"));
1808 /* change '\\' in %HOME% to '/' */
1809 g_strdelimit (g_home_dir, "\\",'/');
1812 g_user_name = g_strdup ("somebody");
1814 g_real_name = g_strdup ("Unknown");
1818 gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
1820 DWORD size = sizeof (hostname);
1821 gboolean hostname_fail = (!GetComputerName (hostname, &size));
1823 g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
1827 g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
1828 g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
1829 g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
1832 g_tmp_dir_cp = g_strdup ("\\");
1833 if (!g_user_name_cp)
1834 g_user_name_cp = g_strdup ("somebody");
1835 if (!g_real_name_cp)
1836 g_real_name_cp = g_strdup ("Unknown");
1838 /* home_dir might be NULL, unlike tmp_dir, user_name and
1842 g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
1844 g_home_dir_cp = NULL;
1845 #endif /* G_OS_WIN32 */
1849 g_get_any_init (void)
1852 g_get_any_init_do ();
1856 g_get_any_init_locked (void)
1858 G_LOCK (g_utils_global);
1860 G_UNLOCK (g_utils_global);
1867 * Gets the user name of the current user. The encoding of the returned
1868 * string is system-defined. On UNIX, it might be the preferred file name
1869 * encoding, or something else, and there is no guarantee that it is even
1870 * consistent on a machine. On Windows, it is always UTF-8.
1872 * Returns: the user name of the current user.
1874 G_CONST_RETURN gchar*
1875 g_get_user_name (void)
1877 g_get_any_init_locked ();
1884 * Gets the real name of the user. This usually comes from the user's entry
1885 * in the <filename>passwd</filename> file. The encoding of the returned
1886 * string is system-defined. (On Windows, it is, however, always UTF-8.)
1887 * If the real user name cannot be determined, the string "Unknown" is
1890 * Returns: the user's real name.
1892 G_CONST_RETURN gchar*
1893 g_get_real_name (void)
1895 g_get_any_init_locked ();
1902 * Gets the current user's home directory as defined in the
1903 * password database.
1905 * Note that in contrast to traditional UNIX tools, this function
1906 * prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
1907 * environment variable.
1909 * One of the reasons for this decision is that applications in many
1910 * cases need special handling to deal with the case where
1911 * <envar>HOME</envar> is
1913 * <member>Not owned by the user</member>
1914 * <member>Not writeable</member>
1915 * <member>Not even readable</member>
1917 * Since applications are in general <emphasis>not</emphasis> written
1918 * to deal with these situations it was considered better to make
1919 * g_get_home_dir() not pay attention to <envar>HOME</envar> and to
1920 * return the real home directory for the user. If applications
1921 * want to pay attention to <envar>HOME</envar>, they can do:
1923 * const char *homedir = g_getenv ("HOME");
1925 * homedir = g_get_home_dir (<!-- -->);
1928 * Returns: the current user's home directory
1930 G_CONST_RETURN gchar*
1931 g_get_home_dir (void)
1933 g_get_any_init_locked ();
1940 * Gets the directory to use for temporary files. This is found from
1941 * inspecting the environment variables <envar>TMPDIR</envar>,
1942 * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
1943 * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
1944 * The encoding of the returned string is system-defined. On Windows,
1945 * it is always UTF-8. The return value is never %NULL or the empty string.
1947 * Returns: the directory to use for temporary files.
1949 G_CONST_RETURN gchar*
1950 g_get_tmp_dir (void)
1952 g_get_any_init_locked ();
1959 * Return a name for the machine.
1961 * The returned name is not necessarily a fully-qualified domain name,
1962 * or even present in DNS or some other name service at all. It need
1963 * not even be unique on your local network or site, but usually it
1964 * is. Callers should not rely on the return value having any specific
1965 * properties like uniqueness for security purposes. Even if the name
1966 * of the machine is changed while an application is running, the
1967 * return value from this function does not change. The returned
1968 * string is owned by GLib and should not be modified or freed. If no
1969 * name can be determined, a default fixed string "localhost" is
1972 * Returns: the host name of the machine.
1977 g_get_host_name (void)
1979 g_get_any_init_locked ();
1983 G_LOCK_DEFINE_STATIC (g_prgname);
1984 static gchar *g_prgname = NULL;
1989 * Gets the name of the program. This name should <emphasis>not</emphasis>
1990 * be localized, contrast with g_get_application_name().
1991 * (If you are using GDK or GTK+ the program name is set in gdk_init(),
1992 * which is called by gtk_init(). The program name is found by taking
1993 * the last component of <literal>argv[0]</literal>.)
1995 * Returns: the name of the program. The returned string belongs
1996 * to GLib and must not be modified or freed.
1999 g_get_prgname (void)
2005 if (g_prgname == NULL)
2007 static gboolean beenhere = FALSE;
2011 gchar *utf8_buf = NULL;
2012 wchar_t buf[MAX_PATH+1];
2015 if (GetModuleFileNameW (GetModuleHandle (NULL),
2016 buf, G_N_ELEMENTS (buf)) > 0)
2017 utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
2021 g_prgname = g_path_get_basename (utf8_buf);
2028 G_UNLOCK (g_prgname);
2035 * @prgname: the name of the program.
2037 * Sets the name of the program. This name should <emphasis>not</emphasis>
2038 * be localized, contrast with g_set_application_name(). Note that for
2039 * thread-safety reasons this function can only be called once.
2042 g_set_prgname (const gchar *prgname)
2046 g_prgname = g_strdup (prgname);
2047 G_UNLOCK (g_prgname);
2050 G_LOCK_DEFINE_STATIC (g_application_name);
2051 static gchar *g_application_name = NULL;
2054 * g_get_application_name:
2056 * Gets a human-readable name for the application, as set by
2057 * g_set_application_name(). This name should be localized if
2058 * possible, and is intended for display to the user. Contrast with
2059 * g_get_prgname(), which gets a non-localized name. If
2060 * g_set_application_name() has not been called, returns the result of
2061 * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
2064 * Return value: human-readable application name. may return %NULL
2068 G_CONST_RETURN gchar*
2069 g_get_application_name (void)
2073 G_LOCK (g_application_name);
2074 retval = g_application_name;
2075 G_UNLOCK (g_application_name);
2078 return g_get_prgname ();
2084 * g_set_application_name:
2085 * @application_name: localized name of the application
2087 * Sets a human-readable name for the application. This name should be
2088 * localized if possible, and is intended for display to the user.
2089 * Contrast with g_set_prgname(), which sets a non-localized name.
2090 * g_set_prgname() will be called automatically by gtk_init(),
2091 * but g_set_application_name() will not.
2093 * Note that for thread safety reasons, this function can only
2096 * The application name will be used in contexts such as error messages,
2097 * or when displaying an application's name in the task list.
2102 g_set_application_name (const gchar *application_name)
2104 gboolean already_set = FALSE;
2106 G_LOCK (g_application_name);
2107 if (g_application_name)
2110 g_application_name = g_strdup (application_name);
2111 G_UNLOCK (g_application_name);
2114 g_warning ("g_set_application_name() called multiple times");
2118 * g_get_user_data_dir:
2120 * Returns a base directory in which to access application data such
2121 * as icons that is customized for a particular user.
2123 * On UNIX platforms this is determined using the mechanisms described in
2124 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2125 * XDG Base Directory Specification</ulink>.
2126 * In this case the directory retrieved will be XDG_DATA_HOME.
2128 * On Windows this is the folder to use for local (as opposed to
2129 * roaming) application data. See documentation for
2130 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
2131 * what g_get_user_config_dir() returns.
2133 * Return value: a string owned by GLib that must not be modified
2137 G_CONST_RETURN gchar*
2138 g_get_user_data_dir (void)
2142 G_LOCK (g_utils_global);
2144 if (!g_user_data_dir)
2147 data_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
2149 data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
2151 if (data_dir && data_dir[0])
2152 data_dir = g_strdup (data_dir);
2154 if (!data_dir || !data_dir[0])
2159 data_dir = g_build_filename (g_home_dir, ".local",
2162 data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local",
2166 g_user_data_dir = data_dir;
2169 data_dir = g_user_data_dir;
2171 G_UNLOCK (g_utils_global);
2177 g_init_user_config_dir (void)
2181 if (!g_user_config_dir)
2184 config_dir = get_special_folder (CSIDL_LOCAL_APPDATA);
2186 config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
2188 if (config_dir && config_dir[0])
2189 config_dir = g_strdup (config_dir);
2191 if (!config_dir || !config_dir[0])
2196 config_dir = g_build_filename (g_home_dir, ".config", NULL);
2198 config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
2201 g_user_config_dir = config_dir;
2206 * g_get_user_config_dir:
2208 * Returns a base directory in which to store user-specific application
2209 * configuration information such as user preferences and settings.
2211 * On UNIX platforms this is determined using the mechanisms described in
2212 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2213 * XDG Base Directory Specification</ulink>.
2214 * In this case the directory retrieved will be XDG_CONFIG_HOME.
2216 * On Windows this is the folder to use for local (as opposed to
2217 * roaming) application data. See documentation for
2218 * CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
2219 * what g_get_user_data_dir() returns.
2221 * Return value: a string owned by GLib that must not be modified
2225 G_CONST_RETURN gchar*
2226 g_get_user_config_dir (void)
2228 G_LOCK (g_utils_global);
2230 g_init_user_config_dir ();
2232 G_UNLOCK (g_utils_global);
2234 return g_user_config_dir;
2238 * g_get_user_cache_dir:
2240 * Returns a base directory in which to store non-essential, cached
2241 * data specific to particular user.
2243 * On UNIX platforms this is determined using the mechanisms described in
2244 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2245 * XDG Base Directory Specification</ulink>.
2246 * In this case the directory retrieved will be XDG_CACHE_HOME.
2248 * On Windows is the directory that serves as a common repository for
2249 * temporary Internet files. A typical path is
2250 * C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
2251 * See documentation for CSIDL_INTERNET_CACHE.
2253 * Return value: a string owned by GLib that must not be modified
2257 G_CONST_RETURN gchar*
2258 g_get_user_cache_dir (void)
2262 G_LOCK (g_utils_global);
2264 if (!g_user_cache_dir)
2267 cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
2269 cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
2271 if (cache_dir && cache_dir[0])
2272 cache_dir = g_strdup (cache_dir);
2274 if (!cache_dir || !cache_dir[0])
2279 cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
2281 cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
2283 g_user_cache_dir = cache_dir;
2286 cache_dir = g_user_cache_dir;
2288 G_UNLOCK (g_utils_global);
2296 find_folder (OSType type)
2298 gchar *filename = NULL;
2301 if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
2303 CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
2307 CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
2311 filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
2315 filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
2317 CFStringGetCString (path, filename,
2318 CFStringGetLength (path) * 3 + 1,
2319 kCFStringEncodingUTF8);
2333 load_user_special_dirs (void)
2335 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
2336 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
2337 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
2338 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
2339 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
2340 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
2341 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
2342 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
2345 #endif /* HAVE_CARBON */
2347 #if defined(G_OS_WIN32)
2349 load_user_special_dirs (void)
2351 typedef HRESULT (WINAPI *t_SHGetKnownFolderPath) (const GUID *rfid,
2355 t_SHGetKnownFolderPath p_SHGetKnownFolderPath;
2357 static const GUID FOLDERID_Downloads =
2358 { 0x374de290, 0x123f, 0x4565, { 0x91, 0x64, 0x39, 0xc4, 0x92, 0x5e, 0x46, 0x7b } };
2359 static const GUID FOLDERID_Public =
2360 { 0xDFDF76A2, 0xC82A, 0x4D63, { 0x90, 0x6A, 0x56, 0x44, 0xAC, 0x45, 0x73, 0x85 } };
2364 p_SHGetKnownFolderPath = (t_SHGetKnownFolderPath) GetProcAddress (GetModuleHandle ("shell32.dll"),
2365 "SHGetKnownFolderPath");
2367 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
2368 g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
2370 if (p_SHGetKnownFolderPath == NULL)
2372 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
2377 (*p_SHGetKnownFolderPath) (&FOLDERID_Downloads, 0, NULL, &wcp);
2378 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
2379 if (g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] == NULL)
2380 g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
2381 CoTaskMemFree (wcp);
2384 g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
2385 g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
2387 if (p_SHGetKnownFolderPath == NULL)
2390 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
2395 (*p_SHGetKnownFolderPath) (&FOLDERID_Public, 0, NULL, &wcp);
2396 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = g_utf16_to_utf8 (wcp, -1, NULL, NULL, NULL);
2397 if (g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] == NULL)
2398 g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);
2399 CoTaskMemFree (wcp);
2402 g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
2403 g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
2405 #endif /* G_OS_WIN32 */
2407 static void g_init_user_config_dir (void);
2409 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
2411 /* adapted from xdg-user-dir-lookup.c
2413 * Copyright (C) 2007 Red Hat Inc.
2415 * Permission is hereby granted, free of charge, to any person
2416 * obtaining a copy of this software and associated documentation files
2417 * (the "Software"), to deal in the Software without restriction,
2418 * including without limitation the rights to use, copy, modify, merge,
2419 * publish, distribute, sublicense, and/or sell copies of the Software,
2420 * and to permit persons to whom the Software is furnished to do so,
2421 * subject to the following conditions:
2423 * The above copyright notice and this permission notice shall be
2424 * included in all copies or substantial portions of the Software.
2426 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
2427 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
2428 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
2429 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
2430 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
2431 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2432 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2436 load_user_special_dirs (void)
2443 g_init_user_config_dir ();
2444 config_file = g_build_filename (g_user_config_dir,
2448 if (!g_file_get_contents (config_file, &data, NULL, NULL))
2450 g_free (config_file);
2454 lines = g_strsplit (data, "\n", -1);
2455 n_lines = g_strv_length (lines);
2458 for (i = 0; i < n_lines; i++)
2460 gchar *buffer = lines[i];
2463 gboolean is_relative = FALSE;
2464 GUserDirectory directory;
2466 /* Remove newline at end */
2467 len = strlen (buffer);
2468 if (len > 0 && buffer[len - 1] == '\n')
2469 buffer[len - 1] = 0;
2472 while (*p == ' ' || *p == '\t')
2475 if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
2477 directory = G_USER_DIRECTORY_DESKTOP;
2478 p += strlen ("XDG_DESKTOP_DIR");
2480 else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
2482 directory = G_USER_DIRECTORY_DOCUMENTS;
2483 p += strlen ("XDG_DOCUMENTS_DIR");
2485 else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
2487 directory = G_USER_DIRECTORY_DOWNLOAD;
2488 p += strlen ("XDG_DOWNLOAD_DIR");
2490 else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
2492 directory = G_USER_DIRECTORY_MUSIC;
2493 p += strlen ("XDG_MUSIC_DIR");
2495 else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
2497 directory = G_USER_DIRECTORY_PICTURES;
2498 p += strlen ("XDG_PICTURES_DIR");
2500 else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
2502 directory = G_USER_DIRECTORY_PUBLIC_SHARE;
2503 p += strlen ("XDG_PUBLICSHARE_DIR");
2505 else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
2507 directory = G_USER_DIRECTORY_TEMPLATES;
2508 p += strlen ("XDG_TEMPLATES_DIR");
2510 else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
2512 directory = G_USER_DIRECTORY_VIDEOS;
2513 p += strlen ("XDG_VIDEOS_DIR");
2518 while (*p == ' ' || *p == '\t')
2525 while (*p == ' ' || *p == '\t')
2532 if (strncmp (p, "$HOME", 5) == 0)
2540 d = strrchr (p, '"');
2547 /* remove trailing slashes */
2549 if (d[len - 1] == '/')
2555 g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
2558 g_user_special_dirs[directory] = g_strdup (d);
2562 g_free (config_file);
2565 #endif /* G_OS_UNIX && !HAVE_CARBON */
2569 * g_reload_user_special_dirs_cache:
2571 * Resets the cache used for g_get_user_special_dir(), so
2572 * that the latest on-disk version is used. Call this only
2573 * if you just changed the data on disk yourself.
2575 * Due to threadsafety issues this may cause leaking of strings
2576 * that were previously returned from g_get_user_special_dir()
2577 * that can't be freed. We ensure to only leak the data for
2578 * the directories that actually changed value though.
2583 g_reload_user_special_dirs_cache (void)
2587 G_LOCK (g_utils_global);
2589 if (g_user_special_dirs != NULL)
2591 /* save a copy of the pointer, to check if some memory can be preserved */
2592 char **old_g_user_special_dirs = g_user_special_dirs;
2595 /* recreate and reload our cache */
2596 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
2597 load_user_special_dirs ();
2599 /* only leak changed directories */
2600 for (i = 0; i < G_USER_N_DIRECTORIES; i++)
2602 old_val = old_g_user_special_dirs[i];
2603 if (g_strcmp0 (old_val, g_user_special_dirs[i]) == 0)
2606 g_free (g_user_special_dirs[i]);
2607 g_user_special_dirs[i] = old_val;
2613 /* free the old array */
2614 g_free (old_g_user_special_dirs);
2617 G_UNLOCK (g_utils_global);
2621 * g_get_user_special_dir:
2622 * @directory: the logical id of special directory
2624 * Returns the full path of a special directory using its logical id.
2626 * On Unix this is done using the XDG special user directories.
2627 * For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
2628 * falls back to <filename>$HOME/Desktop</filename> when XDG special
2629 * user directories have not been set up.
2631 * Depending on the platform, the user might be able to change the path
2632 * of the special directory without requiring the session to restart; GLib
2633 * will not reflect any change once the special directories are loaded.
2635 * Return value: the path to the specified special directory, or %NULL
2636 * if the logical id was not found. The returned string is owned by
2637 * GLib and should not be modified or freed.
2641 G_CONST_RETURN gchar *
2642 g_get_user_special_dir (GUserDirectory directory)
2644 g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
2645 directory < G_USER_N_DIRECTORIES, NULL);
2647 G_LOCK (g_utils_global);
2649 if (G_UNLIKELY (g_user_special_dirs == NULL))
2651 g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
2653 load_user_special_dirs ();
2655 /* Special-case desktop for historical compatibility */
2656 if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
2660 g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
2661 g_build_filename (g_home_dir, "Desktop", NULL);
2665 G_UNLOCK (g_utils_global);
2667 return g_user_special_dirs[directory];
2672 #undef g_get_system_data_dirs
2675 get_module_for_address (gconstpointer address)
2677 /* Holds the g_utils_global lock */
2679 static gboolean beenhere = FALSE;
2680 typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
2681 static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
2682 HMODULE hmodule = NULL;
2689 p_GetModuleHandleExA =
2690 (t_GetModuleHandleExA) GetProcAddress (GetModuleHandle ("kernel32.dll"),
2691 "GetModuleHandleExA");
2695 if (p_GetModuleHandleExA == NULL ||
2696 !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
2697 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
2700 MEMORY_BASIC_INFORMATION mbi;
2701 VirtualQuery (address, &mbi, sizeof (mbi));
2702 hmodule = (HMODULE) mbi.AllocationBase;
2709 get_module_share_dir (gconstpointer address)
2715 hmodule = get_module_for_address (address);
2716 if (hmodule == NULL)
2719 filename = g_win32_get_package_installation_directory_of_module (hmodule);
2720 retval = g_build_filename (filename, "share", NULL);
2726 G_CONST_RETURN gchar * G_CONST_RETURN *
2727 g_win32_get_system_data_dirs_for_module (void (*address_of_function)())
2731 static GHashTable *per_module_data_dirs = NULL;
2736 if (address_of_function)
2738 G_LOCK (g_utils_global);
2739 hmodule = get_module_for_address (address_of_function);
2740 if (hmodule != NULL)
2742 if (per_module_data_dirs == NULL)
2743 per_module_data_dirs = g_hash_table_new (NULL, NULL);
2746 retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
2750 G_UNLOCK (g_utils_global);
2751 return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2757 data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
2759 /* Documents and Settings\All Users\Application Data */
2760 p = get_special_folder (CSIDL_COMMON_APPDATA);
2762 g_array_append_val (data_dirs, p);
2764 /* Documents and Settings\All Users\Documents */
2765 p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
2767 g_array_append_val (data_dirs, p);
2769 /* Using the above subfolders of Documents and Settings perhaps
2770 * makes sense from a Windows perspective.
2772 * But looking at the actual use cases of this function in GTK+
2773 * and GNOME software, what we really want is the "share"
2774 * subdirectory of the installation directory for the package
2775 * our caller is a part of.
2777 * The address_of_function parameter, if non-NULL, points to a
2778 * function in the calling module. Use that to determine that
2779 * module's installation folder, and use its "share" subfolder.
2781 * Additionally, also use the "share" subfolder of the installation
2782 * locations of GLib and the .exe file being run.
2784 * To guard against none of the above being what is really wanted,
2785 * callers of this function should have Win32-specific code to look
2786 * up their installation folder themselves, and handle a subfolder
2787 * "share" of it in the same way as the folders returned from this
2791 p = get_module_share_dir (address_of_function);
2793 g_array_append_val (data_dirs, p);
2795 if (glib_dll != NULL)
2797 gchar *glib_root = g_win32_get_package_installation_directory_of_module (glib_dll);
2798 p = g_build_filename (glib_root, "share", NULL);
2800 g_array_append_val (data_dirs, p);
2804 exe_root = g_win32_get_package_installation_directory_of_module (NULL);
2805 p = g_build_filename (exe_root, "share", NULL);
2807 g_array_append_val (data_dirs, p);
2810 retval = (gchar **) g_array_free (data_dirs, FALSE);
2812 if (address_of_function)
2814 if (hmodule != NULL)
2815 g_hash_table_insert (per_module_data_dirs, hmodule, retval);
2816 G_UNLOCK (g_utils_global);
2819 return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2825 * g_get_system_data_dirs:
2827 * Returns an ordered list of base directories in which to access
2828 * system-wide application data.
2830 * On UNIX platforms this is determined using the mechanisms described in
2831 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2832 * XDG Base Directory Specification</ulink>
2833 * In this case the list of directories retrieved will be XDG_DATA_DIRS.
2835 * On Windows the first elements in the list are the Application Data
2836 * and Documents folders for All Users. (These can be determined only
2837 * on Windows 2000 or later and are not present in the list on other
2838 * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
2839 * CSIDL_COMMON_DOCUMENTS.
2841 * Then follows the "share" subfolder in the installation folder for
2842 * the package containing the DLL that calls this function, if it can
2845 * Finally the list contains the "share" subfolder in the installation
2846 * folder for GLib, and in the installation folder for the package the
2847 * application's .exe file belongs to.
2849 * The installation folders above are determined by looking up the
2850 * folder where the module (DLL or EXE) in question is located. If the
2851 * folder's name is "bin", its parent is used, otherwise the folder
2854 * Note that on Windows the returned list can vary depending on where
2855 * this function is called.
2857 * Return value: a %NULL-terminated array of strings owned by GLib that must
2858 * not be modified or freed.
2861 G_CONST_RETURN gchar * G_CONST_RETURN *
2862 g_get_system_data_dirs (void)
2864 gchar **data_dir_vector;
2866 G_LOCK (g_utils_global);
2868 if (!g_system_data_dirs)
2871 data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2873 gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2875 if (!data_dirs || !data_dirs[0])
2876 data_dirs = "/usr/local/share/:/usr/share/";
2878 data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2881 g_system_data_dirs = data_dir_vector;
2884 data_dir_vector = g_system_data_dirs;
2886 G_UNLOCK (g_utils_global);
2888 return (G_CONST_RETURN gchar * G_CONST_RETURN *) data_dir_vector;
2892 * g_get_system_config_dirs:
2894 * Returns an ordered list of base directories in which to access
2895 * system-wide configuration information.
2897 * On UNIX platforms this is determined using the mechanisms described in
2898 * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2899 * XDG Base Directory Specification</ulink>.
2900 * In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
2902 * On Windows is the directory that contains application data for all users.
2903 * A typical path is C:\Documents and Settings\All Users\Application Data.
2904 * This folder is used for application data that is not user specific.
2905 * For example, an application can store a spell-check dictionary, a database
2906 * of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
2907 * This information will not roam and is available to anyone using the computer.
2909 * Return value: a %NULL-terminated array of strings owned by GLib that must
2910 * not be modified or freed.
2913 G_CONST_RETURN gchar * G_CONST_RETURN *
2914 g_get_system_config_dirs (void)
2916 gchar *conf_dirs, **conf_dir_vector;
2918 G_LOCK (g_utils_global);
2920 if (!g_system_config_dirs)
2923 conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2926 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2931 /* Return empty list */
2932 conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2935 conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2937 if (!conf_dirs || !conf_dirs[0])
2938 conf_dirs = "/etc/xdg";
2940 conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2943 g_system_config_dirs = conf_dir_vector;
2946 conf_dir_vector = g_system_config_dirs;
2947 G_UNLOCK (g_utils_global);
2949 return (G_CONST_RETURN gchar * G_CONST_RETURN *) conf_dir_vector;
2954 static GHashTable *alias_table = NULL;
2956 /* read an alias file for the locales */
2958 read_aliases (gchar *file)
2964 alias_table = g_hash_table_new (g_str_hash, g_str_equal);
2965 fp = fopen (file,"r");
2968 while (fgets (buf, 256, fp))
2974 /* Line is a comment */
2975 if ((buf[0] == '#') || (buf[0] == '\0'))
2978 /* Reads first column */
2979 for (p = buf, q = NULL; *p; p++) {
2980 if ((*p == '\t') || (*p == ' ') || (*p == ':')) {
2983 while ((*q == '\t') || (*q == ' ')) {
2989 /* The line only had one column */
2990 if (!q || *q == '\0')
2993 /* Read second column */
2994 for (p = q; *p; p++) {
2995 if ((*p == '\t') || (*p == ' ')) {
3001 /* Add to alias table if necessary */
3002 if (!g_hash_table_lookup (alias_table, buf)) {
3003 g_hash_table_insert (alias_table, g_strdup (buf), g_strdup (q));
3012 unalias_lang (char *lang)
3019 read_aliases ("/usr/share/locale/locale.alias");
3022 while ((p = g_hash_table_lookup (alias_table, lang)) && (strcmp (p, lang) != 0))
3027 static gboolean said_before = FALSE;
3029 g_warning ("Too many alias levels for a locale, "
3030 "may indicate a loop");
3039 /* Mask for components of locale spec. The ordering here is from
3040 * least significant to most significant
3044 COMPONENT_CODESET = 1 << 0,
3045 COMPONENT_TERRITORY = 1 << 1,
3046 COMPONENT_MODIFIER = 1 << 2
3049 /* Break an X/Open style locale specification into components
3052 explode_locale (const gchar *locale,
3058 const gchar *uscore_pos;
3059 const gchar *at_pos;
3060 const gchar *dot_pos;
3064 uscore_pos = strchr (locale, '_');
3065 dot_pos = strchr (uscore_pos ? uscore_pos : locale, '.');
3066 at_pos = strchr (dot_pos ? dot_pos : (uscore_pos ? uscore_pos : locale), '@');
3070 mask |= COMPONENT_MODIFIER;
3071 *modifier = g_strdup (at_pos);
3074 at_pos = locale + strlen (locale);
3078 mask |= COMPONENT_CODESET;
3079 *codeset = g_strndup (dot_pos, at_pos - dot_pos);
3086 mask |= COMPONENT_TERRITORY;
3087 *territory = g_strndup (uscore_pos, dot_pos - uscore_pos);
3090 uscore_pos = dot_pos;
3092 *language = g_strndup (locale, uscore_pos - locale);
3098 * Compute all interesting variants for a given locale name -
3099 * by stripping off different components of the value.
3101 * For simplicity, we assume that the locale is in
3102 * X/Open format: language[_territory][.codeset][@modifier]
3104 * TODO: Extend this to handle the CEN format (see the GNUlibc docs)
3105 * as well. We could just copy the code from glibc wholesale
3106 * but it is big, ugly, and complicated, so I'm reluctant
3107 * to do so when this should handle 99% of the time...
3110 _g_compute_locale_variants (const gchar *locale)
3112 GSList *retval = NULL;
3114 gchar *language = NULL;
3115 gchar *territory = NULL;
3116 gchar *codeset = NULL;
3117 gchar *modifier = NULL;
3122 g_return_val_if_fail (locale != NULL, NULL);
3124 mask = explode_locale (locale, &language, &territory, &codeset, &modifier);
3126 /* Iterate through all possible combinations, from least attractive
3127 * to most attractive.
3129 for (i = 0; i <= mask; i++)
3130 if ((i & ~mask) == 0)
3132 gchar *val = g_strconcat (language,
3133 (i & COMPONENT_TERRITORY) ? territory : "",
3134 (i & COMPONENT_CODESET) ? codeset : "",
3135 (i & COMPONENT_MODIFIER) ? modifier : "",
3137 retval = g_slist_prepend (retval, val);
3141 if (mask & COMPONENT_CODESET)
3143 if (mask & COMPONENT_TERRITORY)
3145 if (mask & COMPONENT_MODIFIER)
3151 /* The following is (partly) taken from the gettext package.
3152 Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc. */
3154 static const gchar *
3155 guess_category_value (const gchar *category_name)
3157 const gchar *retval;
3159 /* The highest priority value is the `LANGUAGE' environment
3160 variable. This is a GNU extension. */
3161 retval = g_getenv ("LANGUAGE");
3162 if ((retval != NULL) && (retval[0] != '\0'))
3165 /* `LANGUAGE' is not set. So we have to proceed with the POSIX
3166 methods of looking to `LC_ALL', `LC_xxx', and `LANG'. On some
3167 systems this can be done by the `setlocale' function itself. */
3169 /* Setting of LC_ALL overwrites all other. */
3170 retval = g_getenv ("LC_ALL");
3171 if ((retval != NULL) && (retval[0] != '\0'))
3174 /* Next comes the name of the desired category. */
3175 retval = g_getenv (category_name);
3176 if ((retval != NULL) && (retval[0] != '\0'))
3179 /* Last possibility is the LANG environment variable. */
3180 retval = g_getenv ("LANG");
3181 if ((retval != NULL) && (retval[0] != '\0'))
3184 #ifdef G_PLATFORM_WIN32
3185 /* g_win32_getlocale() first checks for LC_ALL, LC_MESSAGES and
3186 * LANG, which we already did above. Oh well. The main point of
3187 * calling g_win32_getlocale() is to get the thread's locale as used
3188 * by Windows and the Microsoft C runtime (in the "English_United
3189 * States" format) translated into the Unixish format.
3192 char *locale = g_win32_getlocale ();
3193 retval = g_intern_string (locale);
3202 typedef struct _GLanguageNamesCache GLanguageNamesCache;
3204 struct _GLanguageNamesCache {
3206 gchar **language_names;
3210 language_names_cache_free (gpointer data)
3212 GLanguageNamesCache *cache = data;
3213 g_free (cache->languages);
3214 g_strfreev (cache->language_names);
3219 * g_get_language_names:
3221 * Computes a list of applicable locale names, which can be used to
3222 * e.g. construct locale-dependent filenames or search paths. The returned
3223 * list is sorted from most desirable to least desirable and always contains
3224 * the default locale "C".
3226 * For example, if LANGUAGE=de:en_US, then the returned list is
3227 * "de", "en_US", "en", "C".
3229 * This function consults the environment variables <envar>LANGUAGE</envar>,
3230 * <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar>
3231 * to find the list of locales specified by the user.
3233 * Return value: a %NULL-terminated array of strings owned by GLib
3234 * that must not be modified or freed.
3238 G_CONST_RETURN gchar * G_CONST_RETURN *
3239 g_get_language_names (void)
3241 static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
3242 GLanguageNamesCache *cache = g_static_private_get (&cache_private);
3247 cache = g_new0 (GLanguageNamesCache, 1);
3248 g_static_private_set (&cache_private, cache, language_names_cache_free);
3251 value = guess_category_value ("LC_MESSAGES");
3255 if (!(cache->languages && strcmp (cache->languages, value) == 0))
3262 g_free (cache->languages);
3263 g_strfreev (cache->language_names);
3264 cache->languages = g_strdup (value);
3266 alist = g_strsplit (value, ":", 0);
3268 for (a = alist; *a; a++)
3270 gchar *b = unalias_lang (*a);
3271 list = g_slist_concat (list, _g_compute_locale_variants (b));
3274 list = g_slist_append (list, g_strdup ("C"));
3276 cache->language_names = languages = g_new (gchar *, g_slist_length (list) + 1);
3277 for (l = list, i = 0; l; l = l->next, i++)
3278 languages[i] = l->data;
3279 languages[i] = NULL;
3281 g_slist_free (list);
3284 return (G_CONST_RETURN gchar * G_CONST_RETURN *) cache->language_names;
3289 * @v: a #gpointer key
3291 * Converts a gpointer to a hash value.
3292 * It can be passed to g_hash_table_new() as the @hash_func parameter,
3293 * when using pointers as keys in a #GHashTable.
3295 * Returns: a hash value corresponding to the key.
3298 g_direct_hash (gconstpointer v)
3300 return GPOINTER_TO_UINT (v);
3306 * @v2: a key to compare with @v1.
3308 * Compares two #gpointer arguments and returns %TRUE if they are equal.
3309 * It can be passed to g_hash_table_new() as the @key_equal_func
3310 * parameter, when using pointers as keys in a #GHashTable.
3312 * Returns: %TRUE if the two keys match.
3315 g_direct_equal (gconstpointer v1,
3323 * @v1: a pointer to a #gint key.
3324 * @v2: a pointer to a #gint key to compare with @v1.
3326 * Compares the two #gint values being pointed to and returns
3327 * %TRUE if they are equal.
3328 * It can be passed to g_hash_table_new() as the @key_equal_func
3329 * parameter, when using pointers to integers as keys in a #GHashTable.
3331 * Returns: %TRUE if the two keys match.
3334 g_int_equal (gconstpointer v1,
3337 return *((const gint*) v1) == *((const gint*) v2);
3342 * @v: a pointer to a #gint key
3344 * Converts a pointer to a #gint to a hash value.
3345 * It can be passed to g_hash_table_new() as the @hash_func parameter,
3346 * when using pointers to integers values as keys in a #GHashTable.
3348 * Returns: a hash value corresponding to the key.
3351 g_int_hash (gconstpointer v)
3353 return *(const gint*) v;
3358 * @v1: a pointer to a #gint64 key.
3359 * @v2: a pointer to a #gint64 key to compare with @v1.
3361 * Compares the two #gint64 values being pointed to and returns
3362 * %TRUE if they are equal.
3363 * It can be passed to g_hash_table_new() as the @key_equal_func
3364 * parameter, when using pointers to 64-bit integers as keys in a #GHashTable.
3366 * Returns: %TRUE if the two keys match.
3371 g_int64_equal (gconstpointer v1,
3374 return *((const gint64*) v1) == *((const gint64*) v2);
3379 * @v: a pointer to a #gint64 key
3381 * Converts a pointer to a #gint64 to a hash value.
3382 * It can be passed to g_hash_table_new() as the @hash_func parameter,
3383 * when using pointers to 64-bit integers values as keys in a #GHashTable.
3385 * Returns: a hash value corresponding to the key.
3390 g_int64_hash (gconstpointer v)
3392 return (guint) *(const gint64*) v;
3397 * @v1: a pointer to a #gdouble key.
3398 * @v2: a pointer to a #gdouble key to compare with @v1.
3400 * Compares the two #gdouble values being pointed to and returns
3401 * %TRUE if they are equal.
3402 * It can be passed to g_hash_table_new() as the @key_equal_func
3403 * parameter, when using pointers to doubles as keys in a #GHashTable.
3405 * Returns: %TRUE if the two keys match.
3410 g_double_equal (gconstpointer v1,
3413 return *((const gdouble*) v1) == *((const gdouble*) v2);
3418 * @v: a pointer to a #gdouble key
3420 * Converts a pointer to a #gdouble to a hash value.
3421 * It can be passed to g_hash_table_new() as the @hash_func parameter,
3422 * when using pointers to doubles as keys in a #GHashTable.
3424 * Returns: a hash value corresponding to the key.
3429 g_double_hash (gconstpointer v)
3431 return (guint) *(const gdouble*) v;
3435 * g_nullify_pointer:
3436 * @nullify_location: the memory address of the pointer.
3438 * Set the pointer at the specified location to %NULL.
3441 g_nullify_pointer (gpointer *nullify_location)
3443 g_return_if_fail (nullify_location != NULL);
3445 *nullify_location = NULL;
3451 * Get the codeset for the current locale.
3453 * Return value: a newly allocated string containing the name
3454 * of the codeset. This string must be freed with g_free().
3457 g_get_codeset (void)
3459 const gchar *charset;
3461 g_get_charset (&charset);
3463 return g_strdup (charset);
3466 /* This is called from g_thread_init(). It's used to
3467 * initialize some static data in a threadsafe way.
3470 _g_utils_thread_init (void)
3472 g_get_language_names ();
3478 * _glib_get_locale_dir:
3480 * Return the path to the share\locale or lib\locale subfolder of the
3481 * GLib installation folder. The path is in the system codepage. We
3482 * have to use system codepage as bindtextdomain() doesn't have a
3486 _glib_get_locale_dir (void)
3488 gchar *install_dir = NULL, *locale_dir;
3489 gchar *retval = NULL;
3491 if (glib_dll != NULL)
3492 install_dir = g_win32_get_package_installation_directory_of_module (glib_dll);
3497 * Append "/share/locale" or "/lib/locale" depending on whether
3498 * autoconfigury detected GNU gettext or not.
3500 const char *p = GLIB_LOCALE_DIR + strlen (GLIB_LOCALE_DIR);
3506 locale_dir = g_build_filename (install_dir, p, NULL);
3508 retval = g_win32_locale_filename_from_utf8 (locale_dir);
3510 g_free (install_dir);
3511 g_free (locale_dir);
3517 return g_strdup ("");
3520 #undef GLIB_LOCALE_DIR
3522 #endif /* G_OS_WIN32 */
3526 * @str: The string to be translated
3528 * Returns the translated string from the glib translations.
3529 * This is an internal function and should only be used by
3530 * the internals of glib (such as libgio).
3532 * Returns: the transation of @str to the current locale
3534 G_CONST_RETURN gchar *
3535 glib_gettext (const gchar *str)
3537 static gboolean _glib_gettext_initialized = FALSE;
3539 if (!_glib_gettext_initialized)
3542 gchar *tmp = _glib_get_locale_dir ();
3543 bindtextdomain (GETTEXT_PACKAGE, tmp);
3546 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
3548 # ifdef HAVE_BIND_TEXTDOMAIN_CODESET
3549 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
3551 _glib_gettext_initialized = TRUE;
3554 return g_dgettext (GETTEXT_PACKAGE, str);
3557 #if defined (G_OS_WIN32) && !defined (_WIN64)
3559 /* Binary compatibility versions. Not for newly compiled code. */
3561 #undef g_find_program_in_path
3564 g_find_program_in_path (const gchar *program)
3566 gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
3567 gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
3570 g_free (utf8_program);
3571 if (utf8_retval == NULL)
3573 retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
3574 g_free (utf8_retval);
3579 #undef g_get_current_dir
3582 g_get_current_dir (void)
3584 gchar *utf8_dir = g_get_current_dir_utf8 ();
3585 gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
3592 G_CONST_RETURN gchar*
3593 g_getenv (const gchar *variable)
3595 gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3596 const gchar *utf8_value = g_getenv_utf8 (utf8_variable);
3600 g_free (utf8_variable);
3603 value = g_locale_from_utf8 (utf8_value, -1, NULL, NULL, NULL);
3604 quark = g_quark_from_string (value);
3607 return g_quark_to_string (quark);
3613 g_setenv (const gchar *variable,
3617 gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3618 gchar *utf8_value = g_locale_to_utf8 (value, -1, NULL, NULL, NULL);
3619 gboolean retval = g_setenv_utf8 (utf8_variable, utf8_value, overwrite);
3621 g_free (utf8_variable);
3622 g_free (utf8_value);
3630 g_unsetenv (const gchar *variable)
3632 gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3634 g_unsetenv_utf8 (utf8_variable);
3636 g_free (utf8_variable);
3639 #undef g_get_user_name
3641 G_CONST_RETURN gchar*
3642 g_get_user_name (void)
3644 g_get_any_init_locked ();
3645 return g_user_name_cp;
3648 #undef g_get_real_name
3650 G_CONST_RETURN gchar*
3651 g_get_real_name (void)
3653 g_get_any_init_locked ();
3654 return g_real_name_cp;
3657 #undef g_get_home_dir
3659 G_CONST_RETURN gchar*
3660 g_get_home_dir (void)
3662 g_get_any_init_locked ();
3663 return g_home_dir_cp;
3666 #undef g_get_tmp_dir
3668 G_CONST_RETURN gchar*
3669 g_get_tmp_dir (void)
3671 g_get_any_init_locked ();
3672 return g_tmp_dir_cp;