Expand the docs a bit. (#317775, Søren Sandmann)
[platform/upstream/glib.git] / glib / gutils.c
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1998  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/. 
25  */
26
27 /* 
28  * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
29  */
30
31 #include "config.h"
32
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36 #include <stdarg.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <locale.h>
40 #include <string.h>
41 #include <ctype.h>              /* For tolower() */
42 #include <errno.h>
43 #include <sys/types.h>
44 #include <sys/stat.h>
45 #ifdef HAVE_PWD_H
46 #include <pwd.h>
47 #endif
48 #include <sys/types.h>
49 #ifdef HAVE_SYS_PARAM_H
50 #include <sys/param.h>
51 #endif
52 #ifdef HAVE_CRT_EXTERNS_H 
53 #include <crt_externs.h> /* for _NSGetEnviron */
54 #endif
55
56 /* implement gutils's inline functions
57  */
58 #define G_IMPLEMENT_INLINES 1
59 #define __G_UTILS_C__
60 #include "glib.h"
61 #include "gprintfint.h"
62 #include "gthreadprivate.h"
63 #include "galias.h"
64
65 #ifdef  MAXPATHLEN
66 #define G_PATH_LENGTH   MAXPATHLEN
67 #elif   defined (PATH_MAX)
68 #define G_PATH_LENGTH   PATH_MAX
69 #elif   defined (_PC_PATH_MAX)
70 #define G_PATH_LENGTH   sysconf(_PC_PATH_MAX)
71 #else   
72 #define G_PATH_LENGTH   2048
73 #endif
74
75 #ifdef G_PLATFORM_WIN32
76 #  define STRICT                /* Strict typing, please */
77 #  include <windows.h>
78 #  undef STRICT
79 #  ifndef GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
80 #    define GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT 2
81 #    define GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS 4
82 #  endif
83 #  include <lmcons.h>           /* For UNLEN */
84 #endif /* G_PLATFORM_WIN32 */
85
86 #ifdef G_OS_WIN32
87 #  include <direct.h>
88 #  include <shlobj.h>
89    /* older SDK (e.g. msvc 5.0) does not have these*/
90 #  ifndef CSIDL_MYMUSIC
91 #    define CSIDL_MYMUSIC 13
92 #  endif
93 #  ifndef CSIDL_MYVIDEO
94 #    define CSIDL_MYVIDEO 14
95 #  endif
96 #  ifndef CSIDL_INTERNET_CACHE
97 #    define CSIDL_INTERNET_CACHE 32
98 #  endif
99 #  ifndef CSIDL_COMMON_APPDATA
100 #    define CSIDL_COMMON_APPDATA 35
101 #  endif
102 #  ifndef CSIDL_COMMON_DOCUMENTS
103 #    define CSIDL_COMMON_DOCUMENTS 46
104 #  endif
105 #  ifndef CSIDL_PROFILE
106 #    define CSIDL_PROFILE 40
107 #  endif
108 #  include <process.h>
109 #endif
110
111 #ifdef HAVE_CARBON
112 #include <CoreServices/CoreServices.h>
113 #endif
114
115 #ifdef HAVE_CODESET
116 #include <langinfo.h>
117 #endif
118
119 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
120 #include <libintl.h>
121 #endif
122
123 const guint glib_major_version = GLIB_MAJOR_VERSION;
124 const guint glib_minor_version = GLIB_MINOR_VERSION;
125 const guint glib_micro_version = GLIB_MICRO_VERSION;
126 const guint glib_interface_age = GLIB_INTERFACE_AGE;
127 const guint glib_binary_age = GLIB_BINARY_AGE;
128
129 #ifdef G_PLATFORM_WIN32
130
131 G_WIN32_DLLMAIN_FOR_DLL_NAME (static, dll_name)
132
133 #endif
134
135 /**
136  * glib_check_version:
137  * @required_major: the required major version.
138  * @required_minor: the required minor version.
139  * @required_micro: the required micro version.
140  *
141  * Checks that the GLib library in use is compatible with the
142  * given version. Generally you would pass in the constants
143  * #GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION
144  * as the three arguments to this function; that produces
145  * a check that the library in use is compatible with
146  * the version of GLib the application or module was compiled
147  * against.
148  *
149  * Compatibility is defined by two things: first the version
150  * of the running library is newer than the version
151  * @required_major.required_minor.@required_micro. Second
152  * the running library must be binary compatible with the
153  * version @required_major.required_minor.@required_micro
154  * (same major version.)
155  *
156  * Return value: %NULL if the GLib library is compatible with the
157  *   given version, or a string describing the version mismatch.
158  *   The returned string is owned by GLib and must not be modified
159  *   or freed.
160  *
161  * Since: 2.6
162  **/
163 const gchar *
164 glib_check_version (guint required_major,
165                     guint required_minor,
166                     guint required_micro)
167 {
168   gint glib_effective_micro = 100 * GLIB_MINOR_VERSION + GLIB_MICRO_VERSION;
169   gint required_effective_micro = 100 * required_minor + required_micro;
170
171   if (required_major > GLIB_MAJOR_VERSION)
172     return "GLib version too old (major mismatch)";
173   if (required_major < GLIB_MAJOR_VERSION)
174     return "GLib version too new (major mismatch)";
175   if (required_effective_micro < glib_effective_micro - GLIB_BINARY_AGE)
176     return "GLib version too new (micro mismatch)";
177   if (required_effective_micro > glib_effective_micro)
178     return "GLib version too old (micro mismatch)";
179   return NULL;
180 }
181
182 #if !defined (HAVE_MEMMOVE) && !defined (HAVE_WORKING_BCOPY)
183 /**
184  * g_memmove: 
185  * @dest: the destination address to copy the bytes to.
186  * @src: the source address to copy the bytes from.
187  * @len: the number of bytes to copy.
188  *
189  * Copies a block of memory @len bytes long, from @src to @dest.
190  * The source and destination areas may overlap.
191  *
192  * In order to use this function, you must include 
193  * <filename>string.h</filename> yourself, because this macro will 
194  * typically simply resolve to memmove() and GLib does not include 
195  * <filename>string.h</filename> for you.
196  */
197 void 
198 g_memmove (gpointer      dest, 
199            gconstpointer src, 
200            gulong        len)
201 {
202   gchar* destptr = dest;
203   const gchar* srcptr = src;
204   if (src + len < dest || dest + len < src)
205     {
206       bcopy (src, dest, len);
207       return;
208     }
209   else if (dest <= src)
210     {
211       while (len--)
212         *(destptr++) = *(srcptr++);
213     }
214   else
215     {
216       destptr += len;
217       srcptr += len;
218       while (len--)
219         *(--destptr) = *(--srcptr);
220     }
221 }
222 #endif /* !HAVE_MEMMOVE && !HAVE_WORKING_BCOPY */
223
224 #ifdef G_OS_WIN32
225 #undef g_atexit
226 #endif
227
228 /**
229  * g_atexit:
230  * @func: the function to call on normal program termination.
231  * 
232  * Specifies a function to be called at normal program termination.
233  *
234  * Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor
235  * macro that maps to a call to the atexit() function in the C
236  * library. This means that in case the code that calls g_atexit(),
237  * i.e. atexit(), is in a DLL, the function will be called when the
238  * DLL is detached from the program. This typically makes more sense
239  * than that the function is called when the GLib DLL is detached,
240  * which happened earlier when g_atexit() was a function in the GLib
241  * DLL.
242  *
243  * The behaviour of atexit() in the context of dynamically loaded
244  * modules is not formally specified and varies wildly.
245  *
246  * On POSIX systems, calling g_atexit() (or atexit()) in a dynamically
247  * loaded module which is unloaded before the program terminates might
248  * well cause a crash at program exit.
249  *
250  * Some POSIX systems implement atexit() like Windows, and have each
251  * dynamically loaded module maintain an own atexit chain that is
252  * called when the module is unloaded.
253  *
254  * On other POSIX systems, before a dynamically loaded module is
255  * unloaded, the registered atexit functions (if any) residing in that
256  * module are called, regardless where the code that registered them
257  * resided. This is presumably the most robust approach.
258  *
259  * As can be seen from the above, for portability it's best to avoid
260  * calling g_atexit() (or atexit()) except in the main executable of a
261  * program.
262  */
263 void
264 g_atexit (GVoidFunc func)
265 {
266   gint result;
267   const gchar *error = NULL;
268
269   /* keep this in sync with glib.h */
270
271 #ifdef  G_NATIVE_ATEXIT
272   result = ATEXIT (func);
273   if (result)
274     error = g_strerror (errno);
275 #elif defined (HAVE_ATEXIT)
276 #  ifdef NeXT /* @#%@! NeXTStep */
277   result = !atexit ((void (*)(void)) func);
278   if (result)
279     error = g_strerror (errno);
280 #  else
281   result = atexit ((void (*)(void)) func);
282   if (result)
283     error = g_strerror (errno);
284 #  endif /* NeXT */
285 #elif defined (HAVE_ON_EXIT)
286   result = on_exit ((void (*)(int, void *)) func, NULL);
287   if (result)
288     error = g_strerror (errno);
289 #else
290   result = 0;
291   error = "no implementation";
292 #endif /* G_NATIVE_ATEXIT */
293
294   if (error)
295     g_error ("Could not register atexit() function: %s", error);
296 }
297
298 /* Based on execvp() from GNU Libc.
299  * Some of this code is cut-and-pasted into gspawn.c
300  */
301
302 static gchar*
303 my_strchrnul (const gchar *str, 
304               gchar        c)
305 {
306   gchar *p = (gchar*)str;
307   while (*p && (*p != c))
308     ++p;
309
310   return p;
311 }
312
313 #ifdef G_OS_WIN32
314
315 static gchar *inner_find_program_in_path (const gchar *program);
316
317 gchar*
318 g_find_program_in_path (const gchar *program)
319 {
320   const gchar *last_dot = strrchr (program, '.');
321
322   if (last_dot == NULL ||
323       strchr (last_dot, '\\') != NULL ||
324       strchr (last_dot, '/') != NULL)
325     {
326       const gint program_length = strlen (program);
327       gchar *pathext = g_build_path (";",
328                                      ".exe;.cmd;.bat;.com",
329                                      g_getenv ("PATHEXT"),
330                                      NULL);
331       gchar *p;
332       gchar *decorated_program;
333       gchar *retval;
334
335       p = pathext;
336       do
337         {
338           gchar *q = my_strchrnul (p, ';');
339
340           decorated_program = g_malloc (program_length + (q-p) + 1);
341           memcpy (decorated_program, program, program_length);
342           memcpy (decorated_program+program_length, p, q-p);
343           decorated_program [program_length + (q-p)] = '\0';
344           
345           retval = inner_find_program_in_path (decorated_program);
346           g_free (decorated_program);
347
348           if (retval != NULL)
349             {
350               g_free (pathext);
351               return retval;
352             }
353           p = q;
354         } while (*p++ != '\0');
355       g_free (pathext);
356       return NULL;
357     }
358   else
359     return inner_find_program_in_path (program);
360 }
361
362 #endif
363
364 /**
365  * g_find_program_in_path:
366  * @program: a program name in the GLib file name encoding
367  * 
368  * Locates the first executable named @program in the user's path, in the
369  * same way that execvp() would locate it. Returns an allocated string
370  * with the absolute path name, or %NULL if the program is not found in
371  * the path. If @program is already an absolute path, returns a copy of
372  * @program if @program exists and is executable, and %NULL otherwise.
373  *  
374  * On Windows, if @program does not have a file type suffix, tries
375  * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
376  * the <envar>PATHEXT</envar> environment variable. 
377  * 
378  * On Windows, it looks for the file in the same way as CreateProcess() 
379  * would. This means first in the directory where the executing
380  * program was loaded from, then in the current directory, then in the
381  * Windows 32-bit system directory, then in the Windows directory, and
382  * finally in the directories in the <envar>PATH</envar> environment 
383  * variable. If the program is found, the return value contains the 
384  * full name including the type suffix.
385  *
386  * Return value: absolute path, or %NULL
387  **/
388 #ifdef G_OS_WIN32
389 static gchar *
390 inner_find_program_in_path (const gchar *program)
391 #else
392 gchar*
393 g_find_program_in_path (const gchar *program)
394 #endif
395 {
396   const gchar *path, *p;
397   gchar *name, *freeme;
398 #ifdef G_OS_WIN32
399   const gchar *path_copy;
400   gchar *filename = NULL, *appdir = NULL;
401   gchar *sysdir = NULL, *windir = NULL;
402   int n;
403   wchar_t wfilename[MAXPATHLEN], wsysdir[MAXPATHLEN],
404     wwindir[MAXPATHLEN];
405 #endif
406   gsize len;
407   gsize pathlen;
408
409   g_return_val_if_fail (program != NULL, NULL);
410
411   /* If it is an absolute path, or a relative path including subdirectories,
412    * don't look in PATH.
413    */
414   if (g_path_is_absolute (program)
415       || strchr (program, G_DIR_SEPARATOR) != NULL
416 #ifdef G_OS_WIN32
417       || strchr (program, '/') != NULL
418 #endif
419       )
420     {
421       if (g_file_test (program, G_FILE_TEST_IS_EXECUTABLE) &&
422           !g_file_test (program, G_FILE_TEST_IS_DIR))
423         return g_strdup (program);
424       else
425         return NULL;
426     }
427   
428   path = g_getenv ("PATH");
429 #if defined(G_OS_UNIX) || defined(G_OS_BEOS)
430   if (path == NULL)
431     {
432       /* There is no `PATH' in the environment.  The default
433        * search path in GNU libc is the current directory followed by
434        * the path `confstr' returns for `_CS_PATH'.
435        */
436       
437       /* In GLib we put . last, for security, and don't use the
438        * unportable confstr(); UNIX98 does not actually specify
439        * what to search if PATH is unset. POSIX may, dunno.
440        */
441       
442       path = "/bin:/usr/bin:.";
443     }
444 #else
445   n = GetModuleFileNameW (NULL, wfilename, MAXPATHLEN);
446   if (n > 0 && n < MAXPATHLEN)
447     filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
448   
449   n = GetSystemDirectoryW (wsysdir, MAXPATHLEN);
450   if (n > 0 && n < MAXPATHLEN)
451     sysdir = g_utf16_to_utf8 (wsysdir, -1, NULL, NULL, NULL);
452   
453   n = GetWindowsDirectoryW (wwindir, MAXPATHLEN);
454   if (n > 0 && n < MAXPATHLEN)
455     windir = g_utf16_to_utf8 (wwindir, -1, NULL, NULL, NULL);
456   
457   if (filename)
458     {
459       appdir = g_path_get_dirname (filename);
460       g_free (filename);
461     }
462   
463   path = g_strdup (path);
464
465   if (windir)
466     {
467       const gchar *tem = path;
468       path = g_strconcat (windir, ";", path, NULL);
469       g_free ((gchar *) tem);
470       g_free (windir);
471     }
472   
473   if (sysdir)
474     {
475       const gchar *tem = path;
476       path = g_strconcat (sysdir, ";", path, NULL);
477       g_free ((gchar *) tem);
478       g_free (sysdir);
479     }
480   
481   {
482     const gchar *tem = path;
483     path = g_strconcat (".;", path, NULL);
484     g_free ((gchar *) tem);
485   }
486   
487   if (appdir)
488     {
489       const gchar *tem = path;
490       path = g_strconcat (appdir, ";", path, NULL);
491       g_free ((gchar *) tem);
492       g_free (appdir);
493     }
494
495   path_copy = path;
496 #endif
497   
498   len = strlen (program) + 1;
499   pathlen = strlen (path);
500   freeme = name = g_malloc (pathlen + len + 1);
501   
502   /* Copy the file name at the top, including '\0'  */
503   memcpy (name + pathlen + 1, program, len);
504   name = name + pathlen;
505   /* And add the slash before the filename  */
506   *name = G_DIR_SEPARATOR;
507   
508   p = path;
509   do
510     {
511       char *startp;
512
513       path = p;
514       p = my_strchrnul (path, G_SEARCHPATH_SEPARATOR);
515
516       if (p == path)
517         /* Two adjacent colons, or a colon at the beginning or the end
518          * of `PATH' means to search the current directory.
519          */
520         startp = name + 1;
521       else
522         startp = memcpy (name - (p - path), path, p - path);
523
524       if (g_file_test (startp, G_FILE_TEST_IS_EXECUTABLE) &&
525           !g_file_test (startp, G_FILE_TEST_IS_DIR))
526         {
527           gchar *ret;
528           ret = g_strdup (startp);
529           g_free (freeme);
530 #ifdef G_OS_WIN32
531           g_free ((gchar *) path_copy);
532 #endif
533           return ret;
534         }
535     }
536   while (*p++ != '\0');
537   
538   g_free (freeme);
539 #ifdef G_OS_WIN32
540   g_free ((gchar *) path_copy);
541 #endif
542
543   return NULL;
544 }
545
546 static gboolean
547 debug_key_matches (const gchar *key,
548                    const gchar *token,
549                    guint        length)
550 {
551   for (; length; length--, key++, token++)
552     {
553       char k = (*key   == '_') ? '-' : tolower (*key  );
554       char t = (*token == '_') ? '-' : tolower (*token);
555
556       if (k != t)
557         return FALSE;
558     }
559
560   return *key == '\0';
561 }
562
563 /**
564  * g_parse_debug_string:
565  * @string: a list of debug options separated by colons, spaces, or
566  * commas; or the string "all" to set all flags.
567  * @keys: pointer to an array of #GDebugKey which associate 
568  *     strings with bit flags.
569  * @nkeys: the number of #GDebugKey<!-- -->s in the array.
570  *
571  * Parses a string containing debugging options
572  * into a %guint containing bit flags. This is used 
573  * within GDK and GTK+ to parse the debug options passed on the
574  * command line or through environment variables.
575  *
576  * Returns: the combined set of bit flags.
577  */
578 guint        
579 g_parse_debug_string  (const gchar     *string, 
580                        const GDebugKey *keys, 
581                        guint            nkeys)
582 {
583   guint i;
584   guint result = 0;
585   
586   g_return_val_if_fail (string != NULL, 0);
587
588   /* this function is used by gmem.c/gslice.c initialization code,
589    * so introducing malloc dependencies here would require adaptions
590    * of those code portions.
591    */
592   
593   if (!g_ascii_strcasecmp (string, "all"))
594     {
595       for (i=0; i<nkeys; i++)
596         result |= keys[i].value;
597     }
598   else
599     {
600       const gchar *p = string;
601       const gchar *q;
602       
603       while (*p)
604         {
605           q = strpbrk (p, ":;, \t");
606           if (!q)
607             q = p + strlen(p);
608           
609           for (i = 0; i < nkeys; i++)
610             if (debug_key_matches (keys[i].key, p, q - p))
611               result |= keys[i].value;
612           
613           p = q;
614           if (*p)
615             p++;
616         }
617     }
618   
619   return result;
620 }
621
622 /**
623  * g_basename:
624  * @file_name: the name of the file.
625  * 
626  * Gets the name of the file without any leading directory components.  
627  * It returns a pointer into the given file name string.
628  * 
629  * Return value: the name of the file without any leading directory components.
630  *
631  * Deprecated:2.2: Use g_path_get_basename() instead, but notice that
632  * g_path_get_basename() allocates new memory for the returned string, unlike
633  * this function which returns a pointer into the argument.
634  **/
635 G_CONST_RETURN gchar*
636 g_basename (const gchar    *file_name)
637 {
638   register gchar *base;
639   
640   g_return_val_if_fail (file_name != NULL, NULL);
641   
642   base = strrchr (file_name, G_DIR_SEPARATOR);
643
644 #ifdef G_OS_WIN32
645   {
646     gchar *q = strrchr (file_name, '/');
647     if (base == NULL || (q != NULL && q > base))
648         base = q;
649   }
650 #endif
651
652   if (base)
653     return base + 1;
654
655 #ifdef G_OS_WIN32
656   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
657     return (gchar*) file_name + 2;
658 #endif /* G_OS_WIN32 */
659   
660   return (gchar*) file_name;
661 }
662
663 /**
664  * g_path_get_basename:
665  * @file_name: the name of the file.
666  *
667  * Gets the last component of the filename. If @file_name ends with a 
668  * directory separator it gets the component before the last slash. If 
669  * @file_name consists only of directory separators (and on Windows, 
670  * possibly a drive letter), a single separator is returned. If
671  * @file_name is empty, it gets ".".
672  *
673  * Return value: a newly allocated string containing the last component of 
674  *   the filename.
675  */
676 gchar*
677 g_path_get_basename (const gchar   *file_name)
678 {
679   register gssize base;             
680   register gssize last_nonslash;    
681   gsize len;    
682   gchar *retval;
683  
684   g_return_val_if_fail (file_name != NULL, NULL);
685
686   if (file_name[0] == '\0')
687     /* empty string */
688     return g_strdup (".");
689   
690   last_nonslash = strlen (file_name) - 1;
691
692   while (last_nonslash >= 0 && G_IS_DIR_SEPARATOR (file_name [last_nonslash]))
693     last_nonslash--;
694
695   if (last_nonslash == -1)
696     /* string only containing slashes */
697     return g_strdup (G_DIR_SEPARATOR_S);
698
699 #ifdef G_OS_WIN32
700   if (last_nonslash == 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
701     /* string only containing slashes and a drive */
702     return g_strdup (G_DIR_SEPARATOR_S);
703 #endif /* G_OS_WIN32 */
704
705   base = last_nonslash;
706
707   while (base >=0 && !G_IS_DIR_SEPARATOR (file_name [base]))
708     base--;
709
710 #ifdef G_OS_WIN32
711   if (base == -1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
712     base = 1;
713 #endif /* G_OS_WIN32 */
714
715   len = last_nonslash - base;
716   retval = g_malloc (len + 1);
717   memcpy (retval, file_name + base + 1, len);
718   retval [len] = '\0';
719   return retval;
720 }
721
722 /**
723  * g_path_is_absolute:
724  * @file_name: a file name.
725  *
726  * Returns %TRUE if the given @file_name is an absolute file name,
727  * i.e. it contains a full path from the root directory such as "/usr/local"
728  * on UNIX or "C:\windows" on Windows systems.
729  *
730  * Returns: %TRUE if @file_name is an absolute path. 
731  */
732 gboolean
733 g_path_is_absolute (const gchar *file_name)
734 {
735   g_return_val_if_fail (file_name != NULL, FALSE);
736   
737   if (G_IS_DIR_SEPARATOR (file_name[0]))
738     return TRUE;
739
740 #ifdef G_OS_WIN32
741   /* Recognize drive letter on native Windows */
742   if (g_ascii_isalpha (file_name[0]) && 
743       file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
744     return TRUE;
745 #endif /* G_OS_WIN32 */
746
747   return FALSE;
748 }
749
750 /**
751  * g_path_skip_root:
752  * @file_name: a file name.
753  *
754  * Returns a pointer into @file_name after the root component, i.e. after
755  * the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute
756  * path it returns %NULL.
757  *
758  * Returns: a pointer into @file_name after the root component.
759  */
760 G_CONST_RETURN gchar*
761 g_path_skip_root (const gchar *file_name)
762 {
763   g_return_val_if_fail (file_name != NULL, NULL);
764   
765 #ifdef G_PLATFORM_WIN32
766   /* Skip \\server\share or //server/share */
767   if (G_IS_DIR_SEPARATOR (file_name[0]) &&
768       G_IS_DIR_SEPARATOR (file_name[1]) &&
769       file_name[2] &&
770       !G_IS_DIR_SEPARATOR (file_name[2]))
771     {
772       gchar *p;
773
774       p = strchr (file_name + 2, G_DIR_SEPARATOR);
775 #ifdef G_OS_WIN32
776       {
777         gchar *q = strchr (file_name + 2, '/');
778         if (p == NULL || (q != NULL && q < p))
779           p = q;
780       }
781 #endif
782       if (p &&
783           p > file_name + 2 &&
784           p[1])
785         {
786           file_name = p + 1;
787
788           while (file_name[0] && !G_IS_DIR_SEPARATOR (file_name[0]))
789             file_name++;
790
791           /* Possibly skip a backslash after the share name */
792           if (G_IS_DIR_SEPARATOR (file_name[0]))
793             file_name++;
794
795           return (gchar *)file_name;
796         }
797     }
798 #endif
799   
800   /* Skip initial slashes */
801   if (G_IS_DIR_SEPARATOR (file_name[0]))
802     {
803       while (G_IS_DIR_SEPARATOR (file_name[0]))
804         file_name++;
805       return (gchar *)file_name;
806     }
807
808 #ifdef G_OS_WIN32
809   /* Skip X:\ */
810   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':' && G_IS_DIR_SEPARATOR (file_name[2]))
811     return (gchar *)file_name + 3;
812 #endif
813
814   return NULL;
815 }
816
817 /**
818  * g_path_get_dirname:
819  * @file_name: the name of the file.
820  *
821  * Gets the directory components of a file name.  If the file name has no
822  * directory components "." is returned.  The returned string should be
823  * freed when no longer needed.
824  * 
825  * Returns: the directory components of the file.
826  */
827 gchar*
828 g_path_get_dirname (const gchar    *file_name)
829 {
830   register gchar *base;
831   register gsize len;    
832   
833   g_return_val_if_fail (file_name != NULL, NULL);
834   
835   base = strrchr (file_name, G_DIR_SEPARATOR);
836 #ifdef G_OS_WIN32
837   {
838     gchar *q = strrchr (file_name, '/');
839     if (base == NULL || (q != NULL && q > base))
840         base = q;
841   }
842 #endif
843   if (!base)
844     {
845 #ifdef G_OS_WIN32
846       if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
847         {
848           gchar drive_colon_dot[4];
849
850           drive_colon_dot[0] = file_name[0];
851           drive_colon_dot[1] = ':';
852           drive_colon_dot[2] = '.';
853           drive_colon_dot[3] = '\0';
854
855           return g_strdup (drive_colon_dot);
856         }
857 #endif
858     return g_strdup (".");
859     }
860
861   while (base > file_name && G_IS_DIR_SEPARATOR (*base))
862     base--;
863
864 #ifdef G_OS_WIN32
865   /* base points to the char before the last slash.
866    *
867    * In case file_name is the root of a drive (X:\) or a child of the
868    * root of a drive (X:\foo), include the slash.
869    *
870    * In case file_name is the root share of an UNC path
871    * (\\server\share), add a slash, returning \\server\share\ .
872    *
873    * In case file_name is a direct child of a share in an UNC path
874    * (\\server\share\foo), include the slash after the share name,
875    * returning \\server\share\ .
876    */
877   if (base == file_name + 1 && g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
878     base++;
879   else if (G_IS_DIR_SEPARATOR (file_name[0]) &&
880            G_IS_DIR_SEPARATOR (file_name[1]) &&
881            file_name[2] &&
882            !G_IS_DIR_SEPARATOR (file_name[2]) &&
883            base >= file_name + 2)
884     {
885       const gchar *p = file_name + 2;
886       while (*p && !G_IS_DIR_SEPARATOR (*p))
887         p++;
888       if (p == base + 1)
889         {
890           len = (guint) strlen (file_name) + 1;
891           base = g_new (gchar, len + 1);
892           strcpy (base, file_name);
893           base[len-1] = G_DIR_SEPARATOR;
894           base[len] = 0;
895           return base;
896         }
897       if (G_IS_DIR_SEPARATOR (*p))
898         {
899           p++;
900           while (*p && !G_IS_DIR_SEPARATOR (*p))
901             p++;
902           if (p == base + 1)
903             base++;
904         }
905     }
906 #endif
907
908   len = (guint) 1 + base - file_name;
909   
910   base = g_new (gchar, len + 1);
911   g_memmove (base, file_name, len);
912   base[len] = 0;
913   
914   return base;
915 }
916
917 /**
918  * g_get_current_dir:
919  *
920  * Gets the current directory.
921  * The returned string should be freed when no longer needed. The encoding 
922  * of the returned string is system defined. On Windows, it is always UTF-8.
923  * 
924  * Returns: the current directory.
925  */
926 gchar*
927 g_get_current_dir (void)
928 {
929 #ifdef G_OS_WIN32
930
931   gchar *dir = NULL;
932   wchar_t dummy[2], *wdir;
933   int len;
934
935   len = GetCurrentDirectoryW (2, dummy);
936   wdir = g_new (wchar_t, len);
937
938   if (GetCurrentDirectoryW (len, wdir) == len - 1)
939     dir = g_utf16_to_utf8 (wdir, -1, NULL, NULL, NULL);
940   
941   g_free (wdir);
942
943   if (dir == NULL)
944     dir = g_strdup ("\\");
945
946   return dir;
947
948 #else
949
950   gchar *buffer = NULL;
951   gchar *dir = NULL;
952   static gulong max_len = 0;
953
954   if (max_len == 0) 
955     max_len = (G_PATH_LENGTH == -1) ? 2048 : G_PATH_LENGTH;
956   
957   /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
958    * and, if that wasn't bad enough, hangs in doing so.
959    */
960 #if     (defined (sun) && !defined (__SVR4)) || !defined(HAVE_GETCWD)
961   buffer = g_new (gchar, max_len + 1);
962   *buffer = 0;
963   dir = getwd (buffer);
964 #else   /* !sun || !HAVE_GETCWD */
965   while (max_len < G_MAXULONG / 2)
966     {
967       g_free (buffer);
968       buffer = g_new (gchar, max_len + 1);
969       *buffer = 0;
970       dir = getcwd (buffer, max_len);
971
972       if (dir || errno != ERANGE)
973         break;
974
975       max_len *= 2;
976     }
977 #endif  /* !sun || !HAVE_GETCWD */
978   
979   if (!dir || !*buffer)
980     {
981       /* hm, should we g_error() out here?
982        * this can happen if e.g. "./" has mode \0000
983        */
984       buffer[0] = G_DIR_SEPARATOR;
985       buffer[1] = 0;
986     }
987
988   dir = g_strdup (buffer);
989   g_free (buffer);
990   
991   return dir;
992 #endif /* !Win32 */
993 }
994
995 /**
996  * g_getenv:
997  * @variable: the environment variable to get, in the GLib file name encoding.
998  * 
999  * Returns the value of an environment variable. The name and value
1000  * are in the GLib file name encoding. On UNIX, this means the actual
1001  * bytes which might or might not be in some consistent character set
1002  * and encoding. On Windows, it is in UTF-8. On Windows, in case the
1003  * environment variable's value contains references to other
1004  * environment variables, they are expanded.
1005  * 
1006  * Return value: the value of the environment variable, or %NULL if
1007  * the environment variable is not found. The returned string may be
1008  * overwritten by the next call to g_getenv(), g_setenv() or
1009  * g_unsetenv().
1010  **/
1011 G_CONST_RETURN gchar*
1012 g_getenv (const gchar *variable)
1013 {
1014 #ifndef G_OS_WIN32
1015
1016   g_return_val_if_fail (variable != NULL, NULL);
1017
1018   return getenv (variable);
1019
1020 #else /* G_OS_WIN32 */
1021
1022   GQuark quark;
1023   gchar *value;
1024   wchar_t dummy[2], *wname, *wvalue;
1025   int len;
1026
1027   g_return_val_if_fail (variable != NULL, NULL);
1028   g_return_val_if_fail (g_utf8_validate (variable, -1, NULL), NULL);
1029
1030   /* On Windows NT, it is relatively typical that environment
1031    * variables contain references to other environment variables. If
1032    * so, use ExpandEnvironmentStrings(). (In an ideal world, such
1033    * environment variables would be stored in the Registry as
1034    * REG_EXPAND_SZ type values, and would then get automatically
1035    * expanded before a program sees them. But there is broken software
1036    * that stores environment variables as REG_SZ values even if they
1037    * contain references to other environment variables.)
1038    */
1039
1040   wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1041
1042   len = GetEnvironmentVariableW (wname, dummy, 2);
1043
1044   if (len == 0)
1045     {
1046       g_free (wname);
1047       return NULL;
1048     }
1049   else if (len == 1)
1050     len = 2;
1051
1052   wvalue = g_new (wchar_t, len);
1053
1054   if (GetEnvironmentVariableW (wname, wvalue, len) != len - 1)
1055     {
1056       g_free (wname);
1057       g_free (wvalue);
1058       return NULL;
1059     }
1060
1061   if (wcschr (wvalue, L'%') != NULL)
1062     {
1063       wchar_t *tem = wvalue;
1064
1065       len = ExpandEnvironmentStringsW (wvalue, dummy, 2);
1066
1067       if (len > 0)
1068         {
1069           wvalue = g_new (wchar_t, len);
1070
1071           if (ExpandEnvironmentStringsW (tem, wvalue, len) != len)
1072             {
1073               g_free (wvalue);
1074               wvalue = tem;
1075             }
1076           else
1077             g_free (tem);
1078         }
1079     }
1080
1081   value = g_utf16_to_utf8 (wvalue, -1, NULL, NULL, NULL);
1082
1083   g_free (wname);
1084   g_free (wvalue);
1085
1086   quark = g_quark_from_string (value);
1087   g_free (value);
1088   
1089   return g_quark_to_string (quark);
1090
1091 #endif /* G_OS_WIN32 */
1092 }
1093
1094 /* _g_getenv_nomalloc
1095  * this function does a getenv() without doing any kind of allocation
1096  * through glib. it's suitable for chars <= 127 only (both, for the
1097  * variable name and the contents) and for contents < 1024 chars in
1098  * length. also, it aliases "" to a NULL return value.
1099  **/
1100 const gchar*
1101 _g_getenv_nomalloc (const gchar *variable,
1102                     gchar        buffer[1024])
1103 {
1104   const gchar *retval = getenv (variable);
1105   if (retval && retval[0])
1106     {
1107       gint l = strlen (retval);
1108       if (l < 1024)
1109         {
1110           strncpy (buffer, retval, l);
1111           buffer[l] = 0;
1112           return buffer;
1113         }
1114     }
1115   return NULL;
1116 }
1117
1118 /**
1119  * g_setenv:
1120  * @variable: the environment variable to set, must not contain '='.
1121  * @value: the value for to set the variable to.
1122  * @overwrite: whether to change the variable if it already exists.
1123  *
1124  * Sets an environment variable. Both the variable's name and value
1125  * should be in the GLib file name encoding. On UNIX, this means that
1126  * they can be any sequence of bytes. On Windows, they should be in
1127  * UTF-8.
1128  *
1129  * Note that on some systems, when variables are overwritten, the memory 
1130  * used for the previous variables and its value isn't reclaimed.
1131  *
1132  * Returns: %FALSE if the environment variable couldn't be set.
1133  *
1134  * Since: 2.4
1135  */
1136 gboolean
1137 g_setenv (const gchar *variable, 
1138           const gchar *value, 
1139           gboolean     overwrite)
1140 {
1141 #ifndef G_OS_WIN32
1142
1143   gint result;
1144 #ifndef HAVE_SETENV
1145   gchar *string;
1146 #endif
1147
1148   g_return_val_if_fail (variable != NULL, FALSE);
1149   g_return_val_if_fail (strchr (variable, '=') == NULL, FALSE);
1150
1151 #ifdef HAVE_SETENV
1152   result = setenv (variable, value, overwrite);
1153 #else
1154   if (!overwrite && getenv (variable) != NULL)
1155     return TRUE;
1156   
1157   /* This results in a leak when you overwrite existing
1158    * settings. It would be fairly easy to fix this by keeping
1159    * our own parallel array or hash table.
1160    */
1161   string = g_strconcat (variable, "=", value, NULL);
1162   result = putenv (string);
1163 #endif
1164   return result == 0;
1165
1166 #else /* G_OS_WIN32 */
1167
1168   gboolean retval;
1169   wchar_t *wname, *wvalue, *wassignment;
1170   gchar *tem;
1171
1172   g_return_val_if_fail (variable != NULL, FALSE);
1173   g_return_val_if_fail (strchr (variable, '=') == NULL, FALSE);
1174   g_return_val_if_fail (g_utf8_validate (variable, -1, NULL), FALSE);
1175   g_return_val_if_fail (g_utf8_validate (value, -1, NULL), FALSE);
1176
1177   if (!overwrite && g_getenv (variable) != NULL)
1178     return TRUE;
1179
1180   /* We want to (if possible) set both the environment variable copy
1181    * kept by the C runtime and the one kept by the system.
1182    *
1183    * We can't use only the C runtime's putenv or _wputenv() as that
1184    * won't work for arbitrary Unicode strings in a "non-Unicode" app
1185    * (with main() and not wmain()). In a "main()" app the C runtime
1186    * initializes the C runtime's environment table by converting the
1187    * real (wide char) environment variables to system codepage, thus
1188    * breaking those that aren't representable in the system codepage.
1189    *
1190    * As the C runtime's putenv() will also set the system copy, we do
1191    * the putenv() first, then call SetEnvironmentValueW ourselves.
1192    */
1193
1194   wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1195   wvalue = g_utf8_to_utf16 (value, -1, NULL, NULL, NULL);
1196   tem = g_strconcat (variable, "=", value, NULL);
1197   wassignment = g_utf8_to_utf16 (tem, -1, NULL, NULL, NULL);
1198     
1199   g_free (tem);
1200   _wputenv (wassignment);
1201   g_free (wassignment);
1202
1203   retval = (SetEnvironmentVariableW (wname, wvalue) != 0);
1204
1205   g_free (wname);
1206   g_free (wvalue);
1207
1208   return retval;
1209
1210 #endif /* G_OS_WIN32 */
1211 }
1212
1213 #ifdef HAVE__NSGETENVIRON
1214 #define environ (*_NSGetEnviron())
1215 #elif !defined(G_OS_WIN32)
1216
1217 /* According to the Single Unix Specification, environ is not in 
1218  * any system header, although unistd.h often declares it.
1219  */
1220 extern char **environ;
1221 #endif
1222
1223 /**
1224  * g_unsetenv:
1225  * @variable: the environment variable to remove, must not contain '='.
1226  * 
1227  * Removes an environment variable from the environment.
1228  *
1229  * Note that on some systems, when variables are overwritten, the memory 
1230  * used for the previous variables and its value isn't reclaimed.
1231  * Furthermore, this function can't be guaranteed to operate in a 
1232  * threadsafe way.
1233  *
1234  * Since: 2.4 
1235  **/
1236 void
1237 g_unsetenv (const gchar *variable)
1238 {
1239 #ifndef G_OS_WIN32
1240
1241 #ifdef HAVE_UNSETENV
1242   g_return_if_fail (variable != NULL);
1243   g_return_if_fail (strchr (variable, '=') == NULL);
1244
1245   unsetenv (variable);
1246 #else /* !HAVE_UNSETENV */
1247   int len;
1248   gchar **e, **f;
1249
1250   g_return_if_fail (variable != NULL);
1251   g_return_if_fail (strchr (variable, '=') == NULL);
1252
1253   len = strlen (variable);
1254   
1255   /* Mess directly with the environ array.
1256    * This seems to be the only portable way to do this.
1257    *
1258    * Note that we remove *all* environment entries for
1259    * the variable name, not just the first.
1260    */
1261   e = f = environ;
1262   while (*e != NULL) 
1263     {
1264       if (strncmp (*e, variable, len) != 0 || (*e)[len] != '=') 
1265         {
1266           *f = *e;
1267           f++;
1268         }
1269       e++;
1270     }
1271   *f = NULL;
1272 #endif /* !HAVE_UNSETENV */
1273
1274 #else  /* G_OS_WIN32 */
1275
1276   wchar_t *wname, *wassignment;
1277   gchar *tem;
1278
1279   g_return_if_fail (variable != NULL);
1280   g_return_if_fail (strchr (variable, '=') == NULL);
1281   g_return_if_fail (g_utf8_validate (variable, -1, NULL));
1282
1283   wname = g_utf8_to_utf16 (variable, -1, NULL, NULL, NULL);
1284   tem = g_strconcat (variable, "=", NULL);
1285   wassignment = g_utf8_to_utf16 (tem, -1, NULL, NULL, NULL);
1286     
1287   g_free (tem);
1288   _wputenv (wassignment);
1289   g_free (wassignment);
1290
1291   SetEnvironmentVariableW (wname, NULL);
1292
1293   g_free (wname);
1294
1295 #endif /* G_OS_WIN32 */
1296 }
1297
1298 /**
1299  * g_listenv:
1300  *
1301  * Gets the names of all variables set in the environment.
1302  * 
1303  * Returns: a %NULL-terminated list of strings which must be freed
1304  * with g_strfreev().
1305  *
1306  * Programs that want to be portable to Windows should typically use
1307  * this function and g_getenv() instead of using the environ array
1308  * from the C library directly. On Windows, the strings in the environ
1309  * array are in system codepage encoding, while in most of the typical
1310  * use cases for environment variables in GLib-using programs you want
1311  * the UTF-8 encoding that this function and g_getenv() provide.
1312  *
1313  * Since: 2.8
1314  */
1315 gchar **
1316 g_listenv (void)
1317 {
1318 #ifndef G_OS_WIN32
1319   gchar **result, *eq;
1320   gint len, i, j;
1321
1322   len = g_strv_length (environ);
1323   result = g_new0 (gchar *, len + 1);
1324   
1325   j = 0;
1326   for (i = 0; i < len; i++)
1327     {
1328       eq = strchr (environ[i], '=');
1329       if (eq)
1330         result[j++] = g_strndup (environ[i], eq - environ[i]);
1331     }
1332
1333   result[j] = NULL;
1334
1335   return result;
1336 #else
1337   gchar **result, *eq;
1338   gint len = 0, j;
1339   wchar_t *p, *q;
1340
1341   p = (wchar_t *) GetEnvironmentStringsW ();
1342   if (p != NULL)
1343     {
1344       q = p;
1345       while (*q)
1346         {
1347           q += wcslen (q) + 1;
1348           len++;
1349         }
1350     }
1351   result = g_new0 (gchar *, len + 1);
1352
1353   j = 0;
1354   q = p;
1355   while (*q)
1356     {
1357       result[j] = g_utf16_to_utf8 (q, -1, NULL, NULL, NULL);
1358       if (result[j] != NULL)
1359         {
1360           eq = strchr (result[j], '=');
1361           if (eq && eq > result[j])
1362             {
1363               *eq = '\0';
1364               j++;
1365             }
1366           else
1367             g_free (result[j]);
1368         }
1369       q += wcslen (q) + 1;
1370     }
1371   result[j] = NULL;
1372   FreeEnvironmentStringsW (p);
1373
1374   return result;
1375 #endif
1376 }
1377
1378 G_LOCK_DEFINE_STATIC (g_utils_global);
1379
1380 static  gchar   *g_tmp_dir = NULL;
1381 static  gchar   *g_user_name = NULL;
1382 static  gchar   *g_real_name = NULL;
1383 static  gchar   *g_home_dir = NULL;
1384 static  gchar   *g_host_name = NULL;
1385
1386 #ifdef G_OS_WIN32
1387 /* System codepage versions of the above, kept at file level so that they,
1388  * too, are produced only once.
1389  */
1390 static  gchar   *g_tmp_dir_cp = NULL;
1391 static  gchar   *g_user_name_cp = NULL;
1392 static  gchar   *g_real_name_cp = NULL;
1393 static  gchar   *g_home_dir_cp = NULL;
1394 #endif
1395
1396 static  gchar   *g_user_data_dir = NULL;
1397 static  gchar  **g_system_data_dirs = NULL;
1398 static  gchar   *g_user_cache_dir = NULL;
1399 static  gchar   *g_user_config_dir = NULL;
1400 static  gchar  **g_system_config_dirs = NULL;
1401
1402 static  gchar  **g_user_special_dirs = NULL;
1403
1404 /* fifteen minutes of fame for everybody */
1405 #define G_USER_DIRS_EXPIRE      15 * 60
1406
1407 #ifdef G_OS_WIN32
1408
1409 static gchar *
1410 get_special_folder (int csidl)
1411 {
1412   wchar_t path[MAX_PATH+1];
1413   HRESULT hr;
1414   LPITEMIDLIST pidl = NULL;
1415   BOOL b;
1416   gchar *retval = NULL;
1417
1418   hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
1419   if (hr == S_OK)
1420     {
1421       b = SHGetPathFromIDListW (pidl, path);
1422       if (b)
1423         retval = g_utf16_to_utf8 (path, -1, NULL, NULL, NULL);
1424       CoTaskMemFree (pidl);
1425     }
1426   return retval;
1427 }
1428
1429 static char *
1430 get_windows_directory_root (void)
1431 {
1432   wchar_t wwindowsdir[MAX_PATH];
1433
1434   if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
1435     {
1436       /* Usually X:\Windows, but in terminal server environments
1437        * might be an UNC path, AFAIK.
1438        */
1439       char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
1440       char *p;
1441
1442       if (windowsdir == NULL)
1443         return g_strdup ("C:\\");
1444
1445       p = (char *) g_path_skip_root (windowsdir);
1446       if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
1447         p--;
1448       *p = '\0';
1449       return windowsdir;
1450     }
1451   else
1452     return g_strdup ("C:\\");
1453 }
1454
1455 #endif
1456
1457 /* HOLDS: g_utils_global_lock */
1458 static void
1459 g_get_any_init_do (void)
1460 {
1461   gchar hostname[100];
1462
1463   g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
1464   if (!g_tmp_dir)
1465     g_tmp_dir = g_strdup (g_getenv ("TMP"));
1466   if (!g_tmp_dir)
1467     g_tmp_dir = g_strdup (g_getenv ("TEMP"));
1468
1469 #ifdef G_OS_WIN32
1470   if (!g_tmp_dir)
1471     g_tmp_dir = get_windows_directory_root ();
1472 #else  
1473 #ifdef P_tmpdir
1474   if (!g_tmp_dir)
1475     {
1476       gsize k;    
1477       g_tmp_dir = g_strdup (P_tmpdir);
1478       k = strlen (g_tmp_dir);
1479       if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
1480         g_tmp_dir[k - 1] = '\0';
1481     }
1482 #endif
1483   
1484   if (!g_tmp_dir)
1485     {
1486       g_tmp_dir = g_strdup ("/tmp");
1487     }
1488 #endif  /* !G_OS_WIN32 */
1489   
1490 #ifdef G_OS_WIN32
1491   /* We check $HOME first for Win32, though it is a last resort for Unix
1492    * where we prefer the results of getpwuid().
1493    */
1494   g_home_dir = g_strdup (g_getenv ("HOME"));
1495
1496   /* Only believe HOME if it is an absolute path and exists */
1497   if (g_home_dir)
1498     {
1499       if (!(g_path_is_absolute (g_home_dir) &&
1500             g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
1501         {
1502           g_free (g_home_dir);
1503           g_home_dir = NULL;
1504         }
1505     }
1506   
1507   /* In case HOME is Unix-style (it happens), convert it to
1508    * Windows style.
1509    */
1510   if (g_home_dir)
1511     {
1512       gchar *p;
1513       while ((p = strchr (g_home_dir, '/')) != NULL)
1514         *p = '\\';
1515     }
1516
1517   if (!g_home_dir)
1518     {
1519       /* USERPROFILE is probably the closest equivalent to $HOME? */
1520       if (g_getenv ("USERPROFILE") != NULL)
1521         g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
1522     }
1523
1524   if (!g_home_dir)
1525     g_home_dir = get_special_folder (CSIDL_PROFILE);
1526   
1527   if (!g_home_dir)
1528     g_home_dir = get_windows_directory_root ();
1529 #endif /* G_OS_WIN32 */
1530   
1531 #ifdef HAVE_PWD_H
1532   {
1533     struct passwd *pw = NULL;
1534     gpointer buffer = NULL;
1535     gint error;
1536     gchar *logname;
1537
1538 #  if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
1539     struct passwd pwd;
1540 #    ifdef _SC_GETPW_R_SIZE_MAX  
1541     /* This reurns the maximum length */
1542     glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
1543     
1544     if (bufsize < 0)
1545       bufsize = 64;
1546 #    else /* _SC_GETPW_R_SIZE_MAX */
1547     glong bufsize = 64;
1548 #    endif /* _SC_GETPW_R_SIZE_MAX */
1549
1550     logname = (gchar *) g_getenv ("LOGNAME");
1551         
1552     do
1553       {
1554         g_free (buffer);
1555         /* we allocate 6 extra bytes to work around a bug in 
1556          * Mac OS < 10.3. See #156446
1557          */
1558         buffer = g_malloc (bufsize + 6);
1559         errno = 0;
1560         
1561 #    ifdef HAVE_POSIX_GETPWUID_R
1562         if (logname) {
1563           error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
1564           if (!pw || (pw->pw_uid != getuid ())) {
1565             /* LOGNAME is lying, fall back to looking up the uid */
1566             error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1567           }
1568         } else {
1569           error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1570         }
1571         error = error < 0 ? errno : error;
1572 #    else /* HAVE_NONPOSIX_GETPWUID_R */
1573    /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
1574 #      if defined(_AIX) || defined(__hpux)
1575         error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1576         pw = error == 0 ? &pwd : NULL;
1577 #      else /* !_AIX */
1578         if (logname) {
1579           pw = getpwnam_r (logname, &pwd, buffer, bufsize);
1580           if (!pw || (pw->pw_uid != getuid ())) {
1581             /* LOGNAME is lying, fall back to looking up the uid */
1582             pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1583           }
1584         } else {
1585           pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1586         }
1587         error = pw ? 0 : errno;
1588 #      endif /* !_AIX */            
1589 #    endif /* HAVE_NONPOSIX_GETPWUID_R */
1590         
1591         if (!pw)
1592           {
1593             /* we bail out prematurely if the user id can't be found
1594              * (should be pretty rare case actually), or if the buffer
1595              * should be sufficiently big and lookups are still not
1596              * successfull.
1597              */
1598             if (error == 0 || error == ENOENT)
1599               {
1600                 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
1601                            (gulong) getuid ());
1602                 break;
1603               }
1604             if (bufsize > 32 * 1024)
1605               {
1606                 g_warning ("getpwuid_r(): failed due to: %s.",
1607                            g_strerror (error));
1608                 break;
1609               }
1610             
1611             bufsize *= 2;
1612           }
1613       }
1614     while (!pw);
1615 #  endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
1616     
1617     if (!pw)
1618       {
1619         setpwent ();
1620         pw = getpwuid (getuid ());
1621         endpwent ();
1622       }
1623     if (pw)
1624       {
1625         g_user_name = g_strdup (pw->pw_name);
1626
1627         if (pw->pw_gecos && *pw->pw_gecos != '\0') 
1628           {
1629             gchar **gecos_fields;
1630             gchar **name_parts;
1631
1632             /* split the gecos field and substitute '&' */
1633             gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
1634             name_parts = g_strsplit (gecos_fields[0], "&", 0);
1635             pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
1636             g_real_name = g_strjoinv (pw->pw_name, name_parts);
1637             g_strfreev (gecos_fields);
1638             g_strfreev (name_parts);
1639           }
1640
1641         if (!g_home_dir)
1642           g_home_dir = g_strdup (pw->pw_dir);
1643       }
1644     g_free (buffer);
1645   }
1646   
1647 #else /* !HAVE_PWD_H */
1648   
1649 #ifdef G_OS_WIN32
1650   {
1651     guint len = UNLEN+1;
1652     wchar_t buffer[UNLEN+1];
1653     
1654     if (GetUserNameW (buffer, (LPDWORD) &len))
1655       {
1656         g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
1657         g_real_name = g_strdup (g_user_name);
1658       }
1659   }
1660 #endif /* G_OS_WIN32 */
1661
1662 #endif /* !HAVE_PWD_H */
1663
1664 #ifndef G_OS_WIN32
1665   if (!g_home_dir)
1666     g_home_dir = g_strdup (g_getenv ("HOME"));
1667 #endif
1668
1669 #ifdef __EMX__
1670   /* change '\\' in %HOME% to '/' */
1671   g_strdelimit (g_home_dir, "\\",'/');
1672 #endif
1673   if (!g_user_name)
1674     g_user_name = g_strdup ("somebody");
1675   if (!g_real_name)
1676     g_real_name = g_strdup ("Unknown");
1677
1678   {
1679 #ifndef G_OS_WIN32
1680     gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
1681 #else
1682     DWORD size = sizeof (hostname);
1683     gboolean hostname_fail = (!GetComputerName (hostname, &size));
1684 #endif
1685     g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
1686   }
1687
1688 #ifdef G_OS_WIN32
1689   g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
1690   g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
1691   g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
1692
1693   if (!g_tmp_dir_cp)
1694     g_tmp_dir_cp = g_strdup ("\\");
1695   if (!g_user_name_cp)
1696     g_user_name_cp = g_strdup ("somebody");
1697   if (!g_real_name_cp)
1698     g_real_name_cp = g_strdup ("Unknown");
1699
1700   /* home_dir might be NULL, unlike tmp_dir, user_name and
1701    * real_name.
1702    */
1703   if (g_home_dir)
1704     g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
1705   else
1706     g_home_dir_cp = NULL;
1707 #endif /* G_OS_WIN32 */
1708 }
1709
1710 static inline void
1711 g_get_any_init (void)
1712 {
1713   if (!g_tmp_dir)
1714     g_get_any_init_do ();
1715 }
1716
1717 static inline void
1718 g_get_any_init_locked (void)
1719 {
1720   G_LOCK (g_utils_global);
1721   g_get_any_init ();
1722   G_UNLOCK (g_utils_global);
1723 }
1724
1725
1726 /**
1727  * g_get_user_name:
1728  *
1729  * Gets the user name of the current user. The encoding of the returned
1730  * string is system-defined. On UNIX, it might be the preferred file name
1731  * encoding, or something else, and there is no guarantee that it is even
1732  * consistent on a machine. On Windows, it is always UTF-8.
1733  *
1734  * Returns: the user name of the current user.
1735  */
1736 G_CONST_RETURN gchar*
1737 g_get_user_name (void)
1738 {
1739   g_get_any_init_locked ();
1740   return g_user_name;
1741 }
1742
1743 /**
1744  * g_get_real_name:
1745  *
1746  * Gets the real name of the user. This usually comes from the user's entry 
1747  * in the <filename>passwd</filename> file. The encoding of the returned 
1748  * string is system-defined. (On Windows, it is, however, always UTF-8.) 
1749  * If the real user name cannot be determined, the string "Unknown" is 
1750  * returned.
1751  *
1752  * Returns: the user's real name.
1753  */
1754 G_CONST_RETURN gchar*
1755 g_get_real_name (void)
1756 {
1757   g_get_any_init_locked ();
1758   return g_real_name;
1759 }
1760
1761 /**
1762  * g_get_home_dir:
1763  *
1764  * Gets the current user's home directory as defined in the 
1765  * password database.
1766  *
1767  * Note that in contrast to traditional UNIX tools, this function 
1768  * prefers <filename>passwd</filename> entries over the <envar>HOME</envar> 
1769  * environment variable. 
1770  *
1771  * One of the reasons for this decision is that applications in many 
1772  * cases need special handling to deal with the case where 
1773  * <envar>HOME</envar> is
1774  * <simplelist>
1775  *   <member>Not owned by the user</member>
1776  *   <member>Not writeable</member>
1777  *   <member>Not even readable</member>
1778  * </simplelist>
1779  * Since applications are in general <emphasis>not</emphasis> written 
1780  * to deal with these situations it was considered better to make 
1781  * g_get_homedir() not pay attention to <envar>HOME</envar> and to 
1782  * return the real home directory for the user. If applications
1783  * want to pay attention to <envar>HOME</envar>, they can do:
1784  * <informalexample><programlisting>
1785  *  const char *homedir = g_getenv ("HOME");
1786  *   if (!homedir)
1787  *      homedir = g_get_homedir (<!-- -->);
1788  * </programlisting></informalexample>
1789  *
1790  * Returns: the current user's home directory
1791  */
1792 G_CONST_RETURN gchar*
1793 g_get_home_dir (void)
1794 {
1795   g_get_any_init_locked ();
1796   return g_home_dir;
1797 }
1798
1799 /**
1800  * g_get_tmp_dir:
1801  *
1802  * Gets the directory to use for temporary files. This is found from 
1803  * inspecting the environment variables <envar>TMPDIR</envar>, 
1804  * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none 
1805  * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows. 
1806  * The encoding of the returned string is system-defined. On Windows, 
1807  * it is always UTF-8. The return value is never %NULL.
1808  *
1809  * Returns: the directory to use for temporary files.
1810  */
1811 G_CONST_RETURN gchar*
1812 g_get_tmp_dir (void)
1813 {
1814   g_get_any_init_locked ();
1815   return g_tmp_dir;
1816 }
1817
1818 /**
1819  * g_get_host_name:
1820  *
1821  * Return a name for the machine. 
1822  *
1823  * The returned name is not necessarily a fully-qualified domain name,
1824  * or even present in DNS or some other name service at all. It need
1825  * not even be unique on your local network or site, but usually it
1826  * is. Callers should not rely on the return value having any specific
1827  * properties like uniqueness for security purposes. Even if the name
1828  * of the machine is changed while an application is running, the
1829  * return value from this function does not change. The returned
1830  * string is owned by GLib and should not be modified or freed. If no
1831  * name can be determined, a default fixed string "localhost" is
1832  * returned.
1833  *
1834  * Returns: the host name of the machine.
1835  *
1836  * Since: 2.8
1837  */
1838 const gchar *
1839 g_get_host_name (void)
1840 {
1841   g_get_any_init_locked ();
1842   return g_host_name;
1843 }
1844
1845 G_LOCK_DEFINE_STATIC (g_prgname);
1846 static gchar *g_prgname = NULL;
1847
1848 /**
1849  * g_get_prgname:
1850  *
1851  * Gets the name of the program. This name should <emphasis>not</emphasis> 
1852  * be localized, contrast with g_get_application_name().
1853  * (If you are using GDK or GTK+ the program name is set in gdk_init(), 
1854  * which is called by gtk_init(). The program name is found by taking 
1855  * the last component of <literal>argv[0]</literal>.)
1856  *
1857  * Returns: the name of the program. The returned string belongs 
1858  * to GLib and must not be modified or freed.
1859  */
1860 gchar*
1861 g_get_prgname (void)
1862 {
1863   gchar* retval;
1864
1865   G_LOCK (g_prgname);
1866 #ifdef G_OS_WIN32
1867   if (g_prgname == NULL)
1868     {
1869       static gboolean beenhere = FALSE;
1870
1871       if (!beenhere)
1872         {
1873           gchar *utf8_buf = NULL;
1874           wchar_t buf[MAX_PATH+1];
1875
1876           beenhere = TRUE;
1877           if (GetModuleFileNameW (GetModuleHandle (NULL),
1878                                   buf, G_N_ELEMENTS (buf)) > 0)
1879             utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1880
1881           if (utf8_buf)
1882             {
1883               g_prgname = g_path_get_basename (utf8_buf);
1884               g_free (utf8_buf);
1885             }
1886         }
1887     }
1888 #endif
1889   retval = g_prgname;
1890   G_UNLOCK (g_prgname);
1891
1892   return retval;
1893 }
1894
1895 /**
1896  * g_set_prgname:
1897  * @prgname: the name of the program.
1898  *
1899  * Sets the name of the program. This name should <emphasis>not</emphasis> 
1900  * be localized, contrast with g_set_application_name(). Note that for 
1901  * thread-safety reasons this function can only be called once.
1902  */
1903 void
1904 g_set_prgname (const gchar *prgname)
1905 {
1906   G_LOCK (g_prgname);
1907   g_free (g_prgname);
1908   g_prgname = g_strdup (prgname);
1909   G_UNLOCK (g_prgname);
1910 }
1911
1912 G_LOCK_DEFINE_STATIC (g_application_name);
1913 static gchar *g_application_name = NULL;
1914
1915 /**
1916  * g_get_application_name:
1917  * 
1918  * Gets a human-readable name for the application, as set by
1919  * g_set_application_name(). This name should be localized if
1920  * possible, and is intended for display to the user.  Contrast with
1921  * g_get_prgname(), which gets a non-localized name. If
1922  * g_set_application_name() has not been called, returns the result of
1923  * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1924  * been called).
1925  * 
1926  * Return value: human-readable application name. may return %NULL
1927  *
1928  * Since: 2.2
1929  **/
1930 G_CONST_RETURN gchar*
1931 g_get_application_name (void)
1932 {
1933   gchar* retval;
1934
1935   G_LOCK (g_application_name);
1936   retval = g_application_name;
1937   G_UNLOCK (g_application_name);
1938
1939   if (retval == NULL)
1940     return g_get_prgname ();
1941   
1942   return retval;
1943 }
1944
1945 /**
1946  * g_set_application_name:
1947  * @application_name: localized name of the application
1948  *
1949  * Sets a human-readable name for the application. This name should be
1950  * localized if possible, and is intended for display to the user.
1951  * Contrast with g_set_prgname(), which sets a non-localized name.
1952  * g_set_prgname() will be called automatically by gtk_init(),
1953  * but g_set_application_name() will not.
1954  *
1955  * Note that for thread safety reasons, this function can only
1956  * be called once.
1957  *
1958  * The application name will be used in contexts such as error messages,
1959  * or when displaying an application's name in the task list.
1960  * 
1961  **/
1962 void
1963 g_set_application_name (const gchar *application_name)
1964 {
1965   gboolean already_set = FALSE;
1966         
1967   G_LOCK (g_application_name);
1968   if (g_application_name)
1969     already_set = TRUE;
1970   else
1971     g_application_name = g_strdup (application_name);
1972   G_UNLOCK (g_application_name);
1973
1974   if (already_set)
1975     g_warning ("g_set_application() name called multiple times");
1976 }
1977
1978 /**
1979  * g_get_user_data_dir:
1980  * 
1981  * Returns a base directory in which to access application data such
1982  * as icons that is customized for a particular user.  
1983  *
1984  * On UNIX platforms this is determined using the mechanisms described in
1985  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1986  * XDG Base Directory Specification</ulink>
1987  * 
1988  * Return value: a string owned by GLib that must not be modified 
1989  *               or freed.
1990  * Since: 2.6
1991  **/
1992 G_CONST_RETURN gchar*
1993 g_get_user_data_dir (void)
1994 {
1995   gchar *data_dir;  
1996
1997   G_LOCK (g_utils_global);
1998
1999   if (!g_user_data_dir)
2000     {
2001 #ifdef G_OS_WIN32
2002       data_dir = get_special_folder (CSIDL_PERSONAL);
2003 #else
2004       data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
2005
2006       if (data_dir && data_dir[0])
2007         data_dir = g_strdup (data_dir);
2008 #endif
2009       if (!data_dir || !data_dir[0])
2010         {
2011           g_get_any_init ();
2012
2013           if (g_home_dir)
2014             data_dir = g_build_filename (g_home_dir, ".local", 
2015                                          "share", NULL);
2016           else
2017             data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local", 
2018                                          "share", NULL);
2019         }
2020
2021       g_user_data_dir = data_dir;
2022     }
2023   else
2024     data_dir = g_user_data_dir;
2025
2026   G_UNLOCK (g_utils_global);
2027
2028   return data_dir;
2029 }
2030
2031 static void
2032 g_init_user_config_dir (void)
2033 {
2034   gchar *config_dir;
2035
2036   if (!g_user_config_dir)
2037     {
2038 #ifdef G_OS_WIN32
2039       config_dir = get_special_folder (CSIDL_APPDATA);
2040 #else
2041       config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
2042
2043       if (config_dir && config_dir[0])
2044         config_dir = g_strdup (config_dir);
2045 #endif
2046       if (!config_dir || !config_dir[0])
2047         {
2048           g_get_any_init ();
2049
2050           if (g_home_dir)
2051             config_dir = g_build_filename (g_home_dir, ".config", NULL);
2052           else
2053             config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
2054         }
2055
2056       g_user_config_dir = config_dir;
2057     }
2058 }
2059
2060 /**
2061  * g_get_user_config_dir:
2062  * 
2063  * Returns a base directory in which to store user-specific application 
2064  * configuration information such as user preferences and settings. 
2065  *
2066  * On UNIX platforms this is determined using the mechanisms described in
2067  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2068  * XDG Base Directory Specification</ulink>
2069  * 
2070  * Return value: a string owned by GLib that must not be modified 
2071  *               or freed.
2072  * Since: 2.6
2073  **/
2074 G_CONST_RETURN gchar*
2075 g_get_user_config_dir (void)
2076 {
2077   G_LOCK (g_utils_global);
2078
2079   g_init_user_config_dir ();
2080
2081   G_UNLOCK (g_utils_global);
2082
2083   return g_user_config_dir;
2084 }
2085
2086 /**
2087  * g_get_user_cache_dir:
2088  * 
2089  * Returns a base directory in which to store non-essential, cached
2090  * data specific to particular user.
2091  *
2092  * On UNIX platforms this is determined using the mechanisms described in
2093  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2094  * XDG Base Directory Specification</ulink>
2095  * 
2096  * Return value: a string owned by GLib that must not be modified 
2097  *               or freed.
2098  * Since: 2.6
2099  **/
2100 G_CONST_RETURN gchar*
2101 g_get_user_cache_dir (void)
2102 {
2103   gchar *cache_dir;  
2104
2105   G_LOCK (g_utils_global);
2106
2107   if (!g_user_cache_dir)
2108     {
2109 #ifdef G_OS_WIN32
2110       cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
2111 #else
2112       cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
2113
2114       if (cache_dir && cache_dir[0])
2115           cache_dir = g_strdup (cache_dir);
2116 #endif
2117       if (!cache_dir || !cache_dir[0])
2118         {
2119           g_get_any_init ();
2120         
2121           if (g_home_dir)
2122             cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
2123           else
2124             cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
2125         }
2126       g_user_cache_dir = cache_dir;
2127     }
2128   else
2129     cache_dir = g_user_cache_dir;
2130
2131   G_UNLOCK (g_utils_global);
2132
2133   return cache_dir;
2134 }
2135
2136 #ifdef HAVE_CARBON
2137
2138 static gchar *
2139 find_folder (OSType type)
2140 {
2141   gchar *filename = NULL;
2142   FSRef  found;
2143
2144   if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
2145     {
2146       CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
2147
2148       if (url)
2149         {
2150           CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
2151
2152           if (path)
2153             {
2154               filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
2155
2156               if (! filename)
2157                 {
2158                   filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
2159
2160                   CFStringGetCString (path, filename,
2161                                       CFStringGetLength (path) * 3 + 1,
2162                                       kCFStringEncodingUTF8);
2163                 }
2164
2165               CFRelease (path);
2166             }
2167
2168           CFRelease (url);
2169         }
2170     }
2171
2172   return filename;
2173 }
2174
2175 static void
2176 load_user_special_dirs (void)
2177 {
2178   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
2179   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
2180   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
2181   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
2182   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
2183   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
2184   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
2185   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
2186 }
2187
2188 #endif /* HAVE_CARBON */
2189
2190 #if defined(G_OS_WIN32)
2191 static void
2192 load_user_special_dirs (void)
2193 {
2194   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
2195   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
2196   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY); /* XXX correct ? */
2197   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
2198   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
2199   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);  /* XXX correct ? */
2200   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
2201   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
2202 }
2203 #endif /* G_OS_WIN32 */
2204
2205 static void g_init_user_config_dir (void);
2206
2207 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
2208
2209 /* adapted from xdg-user-dir-lookup.c
2210  *
2211  * Copyright (C) 2007 Red Hat Inc.
2212  *
2213  * Permission is hereby granted, free of charge, to any person
2214  * obtaining a copy of this software and associated documentation files
2215  * (the "Software"), to deal in the Software without restriction,
2216  * including without limitation the rights to use, copy, modify, merge,
2217  * publish, distribute, sublicense, and/or sell copies of the Software,
2218  * and to permit persons to whom the Software is furnished to do so,
2219  * subject to the following conditions: 
2220  *
2221  * The above copyright notice and this permission notice shall be
2222  * included in all copies or substantial portions of the Software. 
2223  *
2224  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
2225  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
2226  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
2227  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
2228  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
2229  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2230  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2231  * SOFTWARE.
2232  */
2233 static void
2234 load_user_special_dirs (void)
2235 {
2236   gchar *config_file;
2237   gchar *data;
2238   gchar **lines;
2239   gint n_lines, i;
2240   
2241   g_init_user_config_dir ();
2242   config_file = g_build_filename (g_user_config_dir,
2243                                   "user-dirs.dirs",
2244                                   NULL);
2245   
2246   if (!g_file_get_contents (config_file, &data, NULL, NULL))
2247     {
2248       g_free (config_file);
2249       return;
2250     }
2251
2252   lines = g_strsplit (data, "\n", -1);
2253   n_lines = g_strv_length (lines);
2254   g_free (data);
2255   
2256   for (i = 0; i < n_lines; i++)
2257     {
2258       gchar *buffer = lines[i];
2259       gchar *d, *p;
2260       gint len;
2261       gboolean is_relative = FALSE;
2262       GUserDirectory directory;
2263
2264       /* Remove newline at end */
2265       len = strlen (buffer);
2266       if (len > 0 && buffer[len - 1] == '\n')
2267         buffer[len - 1] = 0;
2268       
2269       p = buffer;
2270       while (*p == ' ' || *p == '\t')
2271         p++;
2272       
2273       if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
2274         {
2275           directory = G_USER_DIRECTORY_DESKTOP;
2276           p += strlen ("XDG_DESKTOP_DIR");
2277         }
2278       else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
2279         {
2280           directory = G_USER_DIRECTORY_DOCUMENTS;
2281           p += strlen ("XDG_DOCUMENTS_DIR");
2282         }
2283       else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
2284         {
2285           directory = G_USER_DIRECTORY_DOWNLOAD;
2286           p += strlen ("XDG_DOWNLOAD_DIR");
2287         }
2288       else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
2289         {
2290           directory = G_USER_DIRECTORY_MUSIC;
2291           p += strlen ("XDG_MUSIC_DIR");
2292         }
2293       else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
2294         {
2295           directory = G_USER_DIRECTORY_PICTURES;
2296           p += strlen ("XDG_PICTURES_DIR");
2297         }
2298       else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
2299         {
2300           directory = G_USER_DIRECTORY_PUBLIC_SHARE;
2301           p += strlen ("XDG_PUBLICSHARE_DIR");
2302         }
2303       else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
2304         {
2305           directory = G_USER_DIRECTORY_TEMPLATES;
2306           p += strlen ("XDG_TEMPLATES_DIR");
2307         }
2308       else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
2309         {
2310           directory = G_USER_DIRECTORY_VIDEOS;
2311           p += strlen ("XDG_VIDEOS_DIR");
2312         }
2313       else
2314         continue;
2315
2316       while (*p == ' ' || *p == '\t')
2317         p++;
2318
2319       if (*p != '=')
2320         continue;
2321       p++;
2322
2323       while (*p == ' ' || *p == '\t')
2324         p++;
2325
2326       if (*p != '"')
2327         continue;
2328       p++;
2329
2330       if (strncmp (p, "$HOME", 5) == 0)
2331         {
2332           p += 5;
2333           is_relative = TRUE;
2334         }
2335       else if (*p != '/')
2336         continue;
2337
2338       d = strrchr (p, '"');
2339       if (!d)
2340         continue;
2341       *d = 0;
2342
2343       d = p;
2344       
2345       /* remove trailing slashes */
2346       len = strlen (d);
2347       if (d[len - 1] == '/')
2348         d[len - 1] = 0;
2349       
2350       if (is_relative)
2351         {
2352           g_get_any_init ();
2353           g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
2354         }
2355       else
2356         g_user_special_dirs[directory] = g_strdup (d);
2357     }
2358
2359   g_strfreev (lines);
2360   g_free (config_file);
2361 }
2362
2363 #endif /* G_OS_UNIX && !HAVE_CARBON */
2364
2365 /**
2366  * g_get_user_special_dir:
2367  * @directory: the logical id of special directory
2368  *
2369  * Returns the full path of a special directory using its logical id.
2370  *
2371  * On Unix this is done using the XDG special user directories.
2372  *
2373  * Depending on the platform, the user might be able to change the path
2374  * of the special directory without requiring the session to restart; GLib
2375  * will not reflect any change once the special directories are loaded.
2376  *
2377  * Return value: the path to the specified special directory, or %NULL
2378  *   if the logical id was not found. The returned string is owned by
2379  *   GLib and should not be modified or freed.
2380  *
2381  * Since: 2.14
2382  */
2383 G_CONST_RETURN gchar *
2384 g_get_user_special_dir (GUserDirectory directory)
2385 {
2386   g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
2387                         directory < G_USER_N_DIRECTORIES, NULL);
2388
2389   G_LOCK (g_utils_global);
2390
2391   if (G_UNLIKELY (g_user_special_dirs == NULL))
2392     {
2393       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
2394
2395       load_user_special_dirs ();
2396
2397       /* Special-case desktop for historical compatibility */
2398       if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
2399         {
2400           g_get_any_init ();
2401
2402           g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] =
2403             g_build_filename (g_home_dir, "Desktop", NULL);
2404         }
2405     }
2406
2407   G_UNLOCK (g_utils_global);
2408
2409   return g_user_special_dirs[directory];
2410 }
2411
2412 #ifdef G_OS_WIN32
2413
2414 #undef g_get_system_data_dirs
2415
2416 static HMODULE
2417 get_module_for_address (gconstpointer address)
2418 {
2419   /* Holds the g_utils_global lock */
2420
2421   static gboolean beenhere = FALSE;
2422   typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
2423   static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
2424   HMODULE hmodule;
2425
2426   if (!address)
2427     return NULL;
2428
2429   if (!beenhere)
2430     {
2431       p_GetModuleHandleExA =
2432         (t_GetModuleHandleExA) GetProcAddress (LoadLibrary ("kernel32.dll"),
2433                                                "GetModuleHandleExA");
2434       beenhere = TRUE;
2435     }
2436
2437   if (p_GetModuleHandleExA == NULL ||
2438       !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
2439                                 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
2440                                 address, &hmodule))
2441     {
2442       MEMORY_BASIC_INFORMATION mbi;
2443       VirtualQuery (address, &mbi, sizeof (mbi));
2444       hmodule = (HMODULE) mbi.AllocationBase;
2445     }
2446
2447   return hmodule;
2448 }
2449
2450 static gchar *
2451 get_module_share_dir (gconstpointer address)
2452 {
2453   HMODULE hmodule;
2454   gchar *filename = NULL;
2455   gchar *p, *retval;
2456   wchar_t wfilename[MAX_PATH];
2457
2458   hmodule = get_module_for_address (address);
2459   if (hmodule == NULL)
2460     return NULL;
2461
2462   if (GetModuleFileNameW (hmodule, wfilename, G_N_ELEMENTS (wfilename)))
2463     filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
2464
2465   if (filename == NULL)
2466     return NULL;
2467
2468   if ((p = strrchr (filename, G_DIR_SEPARATOR)) != NULL)
2469     *p = '\0';
2470
2471   p = strrchr (filename, G_DIR_SEPARATOR);
2472   if (p && (g_ascii_strcasecmp (p + 1, "bin") == 0))
2473     *p = '\0';
2474
2475   retval = g_build_filename (filename, "share", NULL);
2476   g_free (filename);
2477
2478   return retval;
2479 }
2480
2481 G_CONST_RETURN gchar * G_CONST_RETURN *
2482 g_win32_get_system_data_dirs_for_module (gconstpointer address)
2483 {
2484   GArray *data_dirs;
2485   HMODULE hmodule;
2486   static GHashTable *per_module_data_dirs = NULL;
2487   gchar **retval;
2488   gchar *p;
2489       
2490   if (address)
2491     {
2492       G_LOCK (g_utils_global);
2493       hmodule = get_module_for_address (address);
2494       if (hmodule != NULL)
2495         {
2496           if (per_module_data_dirs == NULL)
2497             per_module_data_dirs = g_hash_table_new (NULL, NULL);
2498           else
2499             {
2500               retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
2501               
2502               if (retval != NULL)
2503                 {
2504                   G_UNLOCK (g_utils_global);
2505                   return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2506                 }
2507             }
2508         }
2509     }
2510
2511   data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
2512
2513   /* Documents and Settings\All Users\Application Data */
2514   p = get_special_folder (CSIDL_COMMON_APPDATA);
2515   if (p)
2516     g_array_append_val (data_dirs, p);
2517   
2518   /* Documents and Settings\All Users\Documents */
2519   p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
2520   if (p)
2521     g_array_append_val (data_dirs, p);
2522         
2523   /* Using the above subfolders of Documents and Settings perhaps
2524    * makes sense from a Windows perspective.
2525    *
2526    * But looking at the actual use cases of this function in GTK+
2527    * and GNOME software, what we really want is the "share"
2528    * subdirectory of the installation directory for the package
2529    * our caller is a part of.
2530    *
2531    * The address parameter, if non-NULL, points to a function in the
2532    * calling module. Use that to determine that module's installation
2533    * folder, and use its "share" subfolder.
2534    *
2535    * Additionally, also use the "share" subfolder of the installation
2536    * locations of GLib and the .exe file being run.
2537    *
2538    * To guard against none of the above being what is really wanted,
2539    * callers of this function should have Win32-specific code to look
2540    * up their installation folder themselves, and handle a subfolder
2541    * "share" of it in the same way as the folders returned from this
2542    * function.
2543    */
2544
2545   p = get_module_share_dir (address);
2546   if (p)
2547     g_array_append_val (data_dirs, p);
2548     
2549   p = g_win32_get_package_installation_subdirectory (NULL, dll_name, "share");
2550   if (p)
2551     g_array_append_val (data_dirs, p);
2552   
2553   p = g_win32_get_package_installation_subdirectory (NULL, NULL, "share");
2554   if (p)
2555     g_array_append_val (data_dirs, p);
2556
2557   retval = (gchar **) g_array_free (data_dirs, FALSE);
2558
2559   if (address)
2560     {
2561       if (hmodule != NULL)
2562         g_hash_table_insert (per_module_data_dirs, hmodule, retval);
2563       G_UNLOCK (g_utils_global);
2564     }
2565
2566   return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2567 }
2568
2569 #endif
2570
2571 /**
2572  * g_get_system_data_dirs:
2573  * 
2574  * Returns an ordered list of base directories in which to access 
2575  * system-wide application data.
2576  *
2577  * On UNIX platforms this is determined using the mechanisms described in
2578  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2579  * XDG Base Directory Specification</ulink>
2580  * 
2581  * On Windows the first elements in the list are the Application Data
2582  * and Documents folders for All Users. (These can be determined only
2583  * on Windows 2000 or later and are not present in the list on other
2584  * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
2585  * CSIDL_COMMON_DOCUMENTS.
2586  *
2587  * Then follows the "share" subfolder in the installation folder for
2588  * the package containing the DLL that calls this function, if it can
2589  * be determined.
2590  * 
2591  * Finally the list contains the "share" subfolder in the installation
2592  * folder for GLib, and in the installation folder for the package the
2593  * application's .exe file belongs to.
2594  *
2595  * The installation folders above are determined by looking up the
2596  * folder where the module (DLL or EXE) in question is located. If the
2597  * folder's name is "bin", its parent is used, otherwise the folder
2598  * itself.
2599  *
2600  * Note that on Windows the returned list can vary depending on where
2601  * this function is called.
2602  *
2603  * Return value: a %NULL-terminated array of strings owned by GLib that must 
2604  *               not be modified or freed.
2605  * Since: 2.6
2606  **/
2607 G_CONST_RETURN gchar * G_CONST_RETURN * 
2608 g_get_system_data_dirs (void)
2609 {
2610   gchar **data_dir_vector;
2611
2612   G_LOCK (g_utils_global);
2613
2614   if (!g_system_data_dirs)
2615     {
2616 #ifdef G_OS_WIN32
2617       data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2618 #else
2619       gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2620
2621       if (!data_dirs || !data_dirs[0])
2622           data_dirs = "/usr/local/share/:/usr/share/";
2623
2624       data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2625 #endif
2626
2627       g_system_data_dirs = data_dir_vector;
2628     }
2629   else
2630     data_dir_vector = g_system_data_dirs;
2631
2632   G_UNLOCK (g_utils_global);
2633
2634   return (G_CONST_RETURN gchar * G_CONST_RETURN *) data_dir_vector;
2635 }
2636
2637 /**
2638  * g_get_system_config_dirs:
2639  * 
2640  * Returns an ordered list of base directories in which to access 
2641  * system-wide configuration information.
2642  *
2643  * On UNIX platforms this is determined using the mechanisms described in
2644  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2645  * XDG Base Directory Specification</ulink>
2646  * 
2647  * Return value: a %NULL-terminated array of strings owned by GLib that must 
2648  *               not be modified or freed.
2649  * Since: 2.6
2650  **/
2651 G_CONST_RETURN gchar * G_CONST_RETURN *
2652 g_get_system_config_dirs (void)
2653 {
2654   gchar *conf_dirs, **conf_dir_vector;
2655
2656   G_LOCK (g_utils_global);
2657
2658   if (!g_system_config_dirs)
2659     {
2660 #ifdef G_OS_WIN32
2661       conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2662       if (conf_dirs)
2663         {
2664           conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2665           g_free (conf_dirs);
2666         }
2667       else
2668         {
2669           /* Return empty list */
2670           conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2671         }
2672 #else
2673       conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2674
2675       if (!conf_dirs || !conf_dirs[0])
2676           conf_dirs = "/etc/xdg";
2677
2678       conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2679 #endif
2680
2681       g_system_config_dirs = conf_dir_vector;
2682     }
2683   else
2684     conf_dir_vector = g_system_config_dirs;
2685   G_UNLOCK (g_utils_global);
2686
2687   return (G_CONST_RETURN gchar * G_CONST_RETURN *) conf_dir_vector;
2688 }
2689
2690 #ifndef G_OS_WIN32
2691
2692 static GHashTable *alias_table = NULL;
2693
2694 /* read an alias file for the locales */
2695 static void
2696 read_aliases (gchar *file)
2697 {
2698   FILE *fp;
2699   char buf[256];
2700   
2701   if (!alias_table)
2702     alias_table = g_hash_table_new (g_str_hash, g_str_equal);
2703   fp = fopen (file,"r");
2704   if (!fp)
2705     return;
2706   while (fgets (buf, 256, fp))
2707     {
2708       char *p, *q;
2709
2710       g_strstrip (buf);
2711
2712       /* Line is a comment */
2713       if ((buf[0] == '#') || (buf[0] == '\0'))
2714         continue;
2715
2716       /* Reads first column */
2717       for (p = buf, q = NULL; *p; p++) {
2718         if ((*p == '\t') || (*p == ' ') || (*p == ':')) {
2719           *p = '\0';
2720           q = p+1;
2721           while ((*q == '\t') || (*q == ' ')) {
2722             q++;
2723           }
2724           break;
2725         }
2726       }
2727       /* The line only had one column */
2728       if (!q || *q == '\0')
2729         continue;
2730       
2731       /* Read second column */
2732       for (p = q; *p; p++) {
2733         if ((*p == '\t') || (*p == ' ')) {
2734           *p = '\0';
2735           break;
2736         }
2737       }
2738
2739       /* Add to alias table if necessary */
2740       if (!g_hash_table_lookup (alias_table, buf)) {
2741         g_hash_table_insert (alias_table, g_strdup (buf), g_strdup (q));
2742       }
2743     }
2744   fclose (fp);
2745 }
2746
2747 #endif
2748
2749 static char *
2750 unalias_lang (char *lang)
2751 {
2752 #ifndef G_OS_WIN32
2753   char *p;
2754   int i;
2755
2756   if (!alias_table)
2757     read_aliases ("/usr/share/locale/locale.alias");
2758
2759   i = 0;
2760   while ((p = g_hash_table_lookup (alias_table, lang)) && (strcmp (p, lang) != 0))
2761     {
2762       lang = p;
2763       if (i++ == 30)
2764         {
2765           static gboolean said_before = FALSE;
2766           if (!said_before)
2767             g_warning ("Too many alias levels for a locale, "
2768                        "may indicate a loop");
2769           said_before = TRUE;
2770           return lang;
2771         }
2772     }
2773 #endif
2774   return lang;
2775 }
2776
2777 /* Mask for components of locale spec. The ordering here is from
2778  * least significant to most significant
2779  */
2780 enum
2781 {
2782   COMPONENT_CODESET =   1 << 0,
2783   COMPONENT_TERRITORY = 1 << 1,
2784   COMPONENT_MODIFIER =  1 << 2
2785 };
2786
2787 /* Break an X/Open style locale specification into components
2788  */
2789 static guint
2790 explode_locale (const gchar *locale,
2791                 gchar      **language, 
2792                 gchar      **territory, 
2793                 gchar      **codeset, 
2794                 gchar      **modifier)
2795 {
2796   const gchar *uscore_pos;
2797   const gchar *at_pos;
2798   const gchar *dot_pos;
2799
2800   guint mask = 0;
2801
2802   uscore_pos = strchr (locale, '_');
2803   dot_pos = strchr (uscore_pos ? uscore_pos : locale, '.');
2804   at_pos = strchr (dot_pos ? dot_pos : (uscore_pos ? uscore_pos : locale), '@');
2805
2806   if (at_pos)
2807     {
2808       mask |= COMPONENT_MODIFIER;
2809       *modifier = g_strdup (at_pos);
2810     }
2811   else
2812     at_pos = locale + strlen (locale);
2813
2814   if (dot_pos)
2815     {
2816       mask |= COMPONENT_CODESET;
2817       *codeset = g_strndup (dot_pos, at_pos - dot_pos);
2818     }
2819   else
2820     dot_pos = at_pos;
2821
2822   if (uscore_pos)
2823     {
2824       mask |= COMPONENT_TERRITORY;
2825       *territory = g_strndup (uscore_pos, dot_pos - uscore_pos);
2826     }
2827   else
2828     uscore_pos = dot_pos;
2829
2830   *language = g_strndup (locale, uscore_pos - locale);
2831
2832   return mask;
2833 }
2834
2835 /*
2836  * Compute all interesting variants for a given locale name -
2837  * by stripping off different components of the value.
2838  *
2839  * For simplicity, we assume that the locale is in
2840  * X/Open format: language[_territory][.codeset][@modifier]
2841  *
2842  * TODO: Extend this to handle the CEN format (see the GNUlibc docs)
2843  *       as well. We could just copy the code from glibc wholesale
2844  *       but it is big, ugly, and complicated, so I'm reluctant
2845  *       to do so when this should handle 99% of the time...
2846  */
2847 GSList *
2848 _g_compute_locale_variants (const gchar *locale)
2849 {
2850   GSList *retval = NULL;
2851
2852   gchar *language = NULL;
2853   gchar *territory = NULL;
2854   gchar *codeset = NULL;
2855   gchar *modifier = NULL;
2856
2857   guint mask;
2858   guint i;
2859
2860   g_return_val_if_fail (locale != NULL, NULL);
2861
2862   mask = explode_locale (locale, &language, &territory, &codeset, &modifier);
2863
2864   /* Iterate through all possible combinations, from least attractive
2865    * to most attractive.
2866    */
2867   for (i = 0; i <= mask; i++)
2868     if ((i & ~mask) == 0)
2869       {
2870         gchar *val = g_strconcat (language,
2871                                   (i & COMPONENT_TERRITORY) ? territory : "",
2872                                   (i & COMPONENT_CODESET) ? codeset : "",
2873                                   (i & COMPONENT_MODIFIER) ? modifier : "",
2874                                   NULL);
2875         retval = g_slist_prepend (retval, val);
2876       }
2877
2878   g_free (language);
2879   if (mask & COMPONENT_CODESET)
2880     g_free (codeset);
2881   if (mask & COMPONENT_TERRITORY)
2882     g_free (territory);
2883   if (mask & COMPONENT_MODIFIER)
2884     g_free (modifier);
2885
2886   return retval;
2887 }
2888
2889 /* The following is (partly) taken from the gettext package.
2890    Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.  */
2891
2892 static const gchar *
2893 guess_category_value (const gchar *category_name)
2894 {
2895   const gchar *retval;
2896
2897   /* The highest priority value is the `LANGUAGE' environment
2898      variable.  This is a GNU extension.  */
2899   retval = g_getenv ("LANGUAGE");
2900   if ((retval != NULL) && (retval[0] != '\0'))
2901     return retval;
2902
2903   /* `LANGUAGE' is not set.  So we have to proceed with the POSIX
2904      methods of looking to `LC_ALL', `LC_xxx', and `LANG'.  On some
2905      systems this can be done by the `setlocale' function itself.  */
2906
2907   /* Setting of LC_ALL overwrites all other.  */
2908   retval = g_getenv ("LC_ALL");  
2909   if ((retval != NULL) && (retval[0] != '\0'))
2910     return retval;
2911
2912   /* Next comes the name of the desired category.  */
2913   retval = g_getenv (category_name);
2914   if ((retval != NULL) && (retval[0] != '\0'))
2915     return retval;
2916
2917   /* Last possibility is the LANG environment variable.  */
2918   retval = g_getenv ("LANG");
2919   if ((retval != NULL) && (retval[0] != '\0'))
2920     return retval;
2921
2922 #ifdef G_PLATFORM_WIN32
2923   /* g_win32_getlocale() first checks for LC_ALL, LC_MESSAGES and
2924    * LANG, which we already did above. Oh well. The main point of
2925    * calling g_win32_getlocale() is to get the thread's locale as used
2926    * by Windows and the Microsoft C runtime (in the "English_United
2927    * States" format) translated into the Unixish format.
2928    */
2929   retval = g_win32_getlocale ();
2930   if ((retval != NULL) && (retval[0] != '\0'))
2931     return retval;
2932 #endif  
2933
2934   return NULL;
2935 }
2936
2937 typedef struct _GLanguageNamesCache GLanguageNamesCache;
2938
2939 struct _GLanguageNamesCache {
2940   gchar *languages;
2941   gchar **language_names;
2942 };
2943
2944 static void
2945 language_names_cache_free (gpointer data)
2946 {
2947   GLanguageNamesCache *cache = data;
2948   g_free (cache->languages);
2949   g_strfreev (cache->language_names);
2950   g_free (cache);
2951 }
2952
2953 /**
2954  * g_get_language_names:
2955  * 
2956  * Computes a list of applicable locale names, which can be used to 
2957  * e.g. construct locale-dependent filenames or search paths. The returned 
2958  * list is sorted from most desirable to least desirable and always contains 
2959  * the default locale "C".
2960  *
2961  * For example, if LANGUAGE=de:en_US, then the returned list is
2962  * "de", "en_US", "en", "C".
2963  *
2964  * This function consults the environment variables <envar>LANGUAGE</envar>, 
2965  * <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar> 
2966  * to find the list of locales specified by the user.
2967  * 
2968  * Return value: a %NULL-terminated array of strings owned by GLib 
2969  *    that must not be modified or freed.
2970  *
2971  * Since: 2.6
2972  **/
2973 G_CONST_RETURN gchar * G_CONST_RETURN * 
2974 g_get_language_names (void)
2975 {
2976   static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
2977   GLanguageNamesCache *cache = g_static_private_get (&cache_private);
2978   const gchar *value;
2979
2980   if (!cache)
2981     {
2982       cache = g_new0 (GLanguageNamesCache, 1);
2983       g_static_private_set (&cache_private, cache, language_names_cache_free);
2984     }
2985
2986   value = guess_category_value ("LC_MESSAGES");
2987   if (!value)
2988     value = "C";
2989
2990   if (!(cache->languages && strcmp (cache->languages, value) == 0))
2991     {
2992       gchar **languages;
2993       gchar **alist, **a;
2994       GSList *list, *l;
2995       gint i;
2996
2997       g_free (cache->languages);
2998       g_strfreev (cache->language_names);
2999       cache->languages = g_strdup (value);
3000
3001       alist = g_strsplit (value, ":", 0);
3002       list = NULL;
3003       for (a = alist; *a; a++)
3004         {
3005           gchar *b = unalias_lang (*a);
3006           list = g_slist_concat (list, _g_compute_locale_variants (b));
3007         }
3008       g_strfreev (alist);
3009       list = g_slist_append (list, g_strdup ("C"));
3010
3011       cache->language_names = languages = g_new (gchar *, g_slist_length (list) + 1);
3012       for (l = list, i = 0; l; l = l->next, i++)
3013         languages[i] = l->data;
3014       languages[i] = NULL;
3015
3016       g_slist_free (list);
3017     }
3018
3019   return (G_CONST_RETURN gchar * G_CONST_RETURN *) cache->language_names;
3020 }
3021
3022 /**
3023  * g_direct_hash:
3024  * @v: a #gpointer key
3025  *
3026  * Converts a gpointer to a hash value.
3027  * It can be passed to g_hash_table_new() as the @hash_func parameter, 
3028  * when using pointers as keys in a #GHashTable.
3029  *
3030  * Returns: a hash value corresponding to the key.
3031  */
3032 guint
3033 g_direct_hash (gconstpointer v)
3034 {
3035   return GPOINTER_TO_UINT (v);
3036 }
3037
3038 /**
3039  * g_direct_equal:
3040  * @v1: a key.
3041  * @v2: a key to compare with @v1.
3042  *
3043  * Compares two #gpointer arguments and returns %TRUE if they are equal.
3044  * It can be passed to g_hash_table_new() as the @key_equal_func
3045  * parameter, when using pointers as keys in a #GHashTable.
3046  * 
3047  * Returns: %TRUE if the two keys match.
3048  */
3049 gboolean
3050 g_direct_equal (gconstpointer v1,
3051                 gconstpointer v2)
3052 {
3053   return v1 == v2;
3054 }
3055
3056 /**
3057  * g_int_equal:
3058  * @v1: a pointer to a #gint key.
3059  * @v2: a pointer to a #gint key to compare with @v1.
3060  *
3061  * Compares the two #gint values being pointed to and returns 
3062  * %TRUE if they are equal.
3063  * It can be passed to g_hash_table_new() as the @key_equal_func
3064  * parameter, when using pointers to integers as keys in a #GHashTable.
3065  * 
3066  * Returns: %TRUE if the two keys match.
3067  */
3068 gboolean
3069 g_int_equal (gconstpointer v1,
3070              gconstpointer v2)
3071 {
3072   return *((const gint*) v1) == *((const gint*) v2);
3073 }
3074
3075 /**
3076  * g_int_hash:
3077  * @v: a pointer to a #gint key
3078  *
3079  * Converts a pointer to a #gint to a hash value.
3080  * It can be passed to g_hash_table_new() as the @hash_func parameter, 
3081  * when using pointers to integers values as keys in a #GHashTable.
3082  *
3083  * Returns: a hash value corresponding to the key.
3084  */
3085 guint
3086 g_int_hash (gconstpointer v)
3087 {
3088   return *(const gint*) v;
3089 }
3090
3091 /**
3092  * g_nullify_pointer:
3093  * @nullify_location: the memory address of the pointer.
3094  * 
3095  * Set the pointer at the specified location to %NULL.
3096  **/
3097 void
3098 g_nullify_pointer (gpointer *nullify_location)
3099 {
3100   g_return_if_fail (nullify_location != NULL);
3101
3102   *nullify_location = NULL;
3103 }
3104
3105 /**
3106  * g_get_codeset:
3107  * 
3108  * Get the codeset for the current locale.
3109  * 
3110  * Return value: a newly allocated string containing the name
3111  * of the codeset. This string must be freed with g_free().
3112  **/
3113 gchar *
3114 g_get_codeset (void)
3115 {
3116   const gchar *charset;
3117
3118   g_get_charset (&charset);
3119
3120   return g_strdup (charset);
3121 }
3122
3123 /* This is called from g_thread_init(). It's used to
3124  * initialize some static data in a threadsafe way.
3125  */
3126 void
3127 _g_utils_thread_init (void)
3128 {
3129   g_get_language_names ();
3130 }
3131
3132 #ifdef ENABLE_NLS
3133
3134 #include <libintl.h>
3135
3136 #ifdef G_OS_WIN32
3137
3138 /**
3139  * _glib_get_locale_dir:
3140  *
3141  * Return the path to the lib\locale subfolder of the GLib
3142  * installation folder. The path is in the system codepage. We have to
3143  * use system codepage as bindtextdomain() doesn't have a UTF-8
3144  * interface.
3145  */
3146 static gchar *
3147 _glib_get_locale_dir (void)
3148 {
3149   gchar *dir, *cp_dir;
3150   gchar *retval = NULL;
3151
3152   dir = g_win32_get_package_installation_directory (GETTEXT_PACKAGE, dll_name);
3153   cp_dir = g_win32_locale_filename_from_utf8 (dir);
3154   g_free (dir);
3155
3156   if (cp_dir)
3157     {
3158       /* Don't use g_build_filename() on pathnames in the system
3159        * codepage. In CJK locales cp_dir might end with a double-byte
3160        * character whose trailing byte is a backslash.
3161        */
3162       retval = g_strconcat (cp_dir, "\\lib\\locale", NULL);
3163       g_free (cp_dir);
3164     }
3165
3166   if (retval)
3167     return retval;
3168   else
3169     return g_strdup ("");
3170 }
3171
3172 #undef GLIB_LOCALE_DIR
3173
3174 #endif /* G_OS_WIN32 */
3175
3176 G_CONST_RETURN gchar *
3177 _glib_gettext (const gchar *str)
3178 {
3179   static gboolean _glib_gettext_initialized = FALSE;
3180
3181   if (!_glib_gettext_initialized)
3182     {
3183 #ifdef G_OS_WIN32
3184       gchar *tmp = _glib_get_locale_dir();
3185       bindtextdomain(GETTEXT_PACKAGE, tmp);
3186       g_free(tmp);
3187 #else
3188       bindtextdomain(GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
3189 #endif
3190 #    ifdef HAVE_BIND_TEXTDOMAIN_CODESET
3191       bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
3192 #    endif
3193       _glib_gettext_initialized = TRUE;
3194     }
3195   
3196   return dgettext (GETTEXT_PACKAGE, str);
3197 }
3198
3199 #endif /* ENABLE_NLS */
3200
3201 #ifdef G_OS_WIN32
3202
3203 /* Binary compatibility versions. Not for newly compiled code. */
3204
3205 #undef g_find_program_in_path
3206
3207 gchar*
3208 g_find_program_in_path (const gchar *program)
3209 {
3210   gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
3211   gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
3212   gchar *retval;
3213
3214   g_free (utf8_program);
3215   if (utf8_retval == NULL)
3216     return NULL;
3217   retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
3218   g_free (utf8_retval);
3219
3220   return retval;
3221 }
3222
3223 #undef g_get_current_dir
3224
3225 gchar*
3226 g_get_current_dir (void)
3227 {
3228   gchar *utf8_dir = g_get_current_dir_utf8 ();
3229   gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
3230   g_free (utf8_dir);
3231   return dir;
3232 }
3233
3234 #undef g_getenv
3235
3236 G_CONST_RETURN gchar*
3237 g_getenv (const gchar *variable)
3238 {
3239   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3240   const gchar *utf8_value = g_getenv_utf8 (utf8_variable);
3241   gchar *value;
3242   GQuark quark;
3243
3244   g_free (utf8_variable);
3245   if (!utf8_value)
3246     return NULL;
3247   value = g_locale_from_utf8 (utf8_value, -1, NULL, NULL, NULL);
3248   quark = g_quark_from_string (value);
3249   g_free (value);
3250
3251   return g_quark_to_string (quark);
3252 }
3253
3254 #undef g_setenv
3255
3256 gboolean
3257 g_setenv (const gchar *variable, 
3258           const gchar *value, 
3259           gboolean     overwrite)
3260 {
3261   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3262   gchar *utf8_value = g_locale_to_utf8 (value, -1, NULL, NULL, NULL);
3263   gboolean retval = g_setenv_utf8 (utf8_variable, utf8_value, overwrite);
3264
3265   g_free (utf8_variable);
3266   g_free (utf8_value);
3267
3268   return retval;
3269 }
3270
3271 #undef g_unsetenv
3272
3273 void
3274 g_unsetenv (const gchar *variable)
3275 {
3276   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3277
3278   g_unsetenv_utf8 (utf8_variable);
3279
3280   g_free (utf8_variable);
3281 }
3282
3283 #undef g_get_user_name
3284
3285 G_CONST_RETURN gchar*
3286 g_get_user_name (void)
3287 {
3288   g_get_any_init_locked ();
3289   return g_user_name_cp;
3290 }
3291
3292 #undef g_get_real_name
3293
3294 G_CONST_RETURN gchar*
3295 g_get_real_name (void)
3296 {
3297   g_get_any_init_locked ();
3298   return g_real_name_cp;
3299 }
3300
3301 #undef g_get_home_dir
3302
3303 G_CONST_RETURN gchar*
3304 g_get_home_dir (void)
3305 {
3306   g_get_any_init_locked ();
3307   return g_home_dir_cp;
3308 }
3309
3310 #undef g_get_tmp_dir
3311
3312 G_CONST_RETURN gchar*
3313 g_get_tmp_dir (void)
3314 {
3315   g_get_any_init_locked ();
3316   return g_tmp_dir_cp;
3317 }
3318
3319 #endif
3320
3321 #define __G_UTILS_C__
3322 #include "galiasdef.c"