Add definitions for more CSIDL_* constants in case missing from headers.
[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       buffer = g_new (gchar, max_len + 1);
968       *buffer = 0;
969       dir = getcwd (buffer, max_len);
970
971       if (dir || errno != ERANGE)
972         break;
973
974       g_free (buffer);
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 static  time_t   g_user_special_dirs_mtime = (time_t) -1;
1404 static  time_t   g_user_special_dirs_stat_time = (time_t) -1;
1405
1406 /* fifteen minutes of fame for everybody */
1407 #define G_USER_DIRS_EXPIRE      15 * 60
1408
1409 #ifdef G_OS_WIN32
1410
1411 static gchar *
1412 get_special_folder (int csidl)
1413 {
1414   union {
1415     char c[MAX_PATH+1];
1416     wchar_t wc[MAX_PATH+1];
1417   } path;
1418   HRESULT hr;
1419   LPITEMIDLIST pidl = NULL;
1420   BOOL b;
1421   gchar *retval = NULL;
1422
1423   hr = SHGetSpecialFolderLocation (NULL, csidl, &pidl);
1424   if (hr == S_OK)
1425     {
1426       b = SHGetPathFromIDListW (pidl, path.wc);
1427       if (b)
1428         retval = g_utf16_to_utf8 (path.wc, -1, NULL, NULL, NULL);
1429       CoTaskMemFree (pidl);
1430     }
1431   return retval;
1432 }
1433
1434 static char *
1435 get_windows_directory_root (void)
1436 {
1437   wchar_t wwindowsdir[MAX_PATH];
1438
1439   if (GetWindowsDirectoryW (wwindowsdir, G_N_ELEMENTS (wwindowsdir)))
1440     {
1441       /* Usually X:\Windows, but in terminal server environments
1442        * might be an UNC path, AFAIK.
1443        */
1444       char *windowsdir = g_utf16_to_utf8 (wwindowsdir, -1, NULL, NULL, NULL);
1445       char *p;
1446
1447       if (windowsdir == NULL)
1448         return g_strdup ("C:\\");
1449
1450       p = (char *) g_path_skip_root (windowsdir);
1451       if (G_IS_DIR_SEPARATOR (p[-1]) && p[-2] != ':')
1452         p--;
1453       *p = '\0';
1454       return windowsdir;
1455     }
1456   else
1457     return g_strdup ("C:\\");
1458 }
1459
1460 #endif
1461
1462 /* HOLDS: g_utils_global_lock */
1463 static void
1464 g_get_any_init_do (void)
1465 {
1466   gchar hostname[100];
1467
1468   g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
1469   if (!g_tmp_dir)
1470     g_tmp_dir = g_strdup (g_getenv ("TMP"));
1471   if (!g_tmp_dir)
1472     g_tmp_dir = g_strdup (g_getenv ("TEMP"));
1473
1474 #ifdef G_OS_WIN32
1475   if (!g_tmp_dir)
1476     g_tmp_dir = get_windows_directory_root ();
1477 #else  
1478 #ifdef P_tmpdir
1479   if (!g_tmp_dir)
1480     {
1481       gsize k;    
1482       g_tmp_dir = g_strdup (P_tmpdir);
1483       k = strlen (g_tmp_dir);
1484       if (k > 1 && G_IS_DIR_SEPARATOR (g_tmp_dir[k - 1]))
1485         g_tmp_dir[k - 1] = '\0';
1486     }
1487 #endif
1488   
1489   if (!g_tmp_dir)
1490     {
1491       g_tmp_dir = g_strdup ("/tmp");
1492     }
1493 #endif  /* !G_OS_WIN32 */
1494   
1495 #ifdef G_OS_WIN32
1496   /* We check $HOME first for Win32, though it is a last resort for Unix
1497    * where we prefer the results of getpwuid().
1498    */
1499   g_home_dir = g_strdup (g_getenv ("HOME"));
1500
1501   /* Only believe HOME if it is an absolute path and exists */
1502   if (g_home_dir)
1503     {
1504       if (!(g_path_is_absolute (g_home_dir) &&
1505             g_file_test (g_home_dir, G_FILE_TEST_IS_DIR)))
1506         {
1507           g_free (g_home_dir);
1508           g_home_dir = NULL;
1509         }
1510     }
1511   
1512   /* In case HOME is Unix-style (it happens), convert it to
1513    * Windows style.
1514    */
1515   if (g_home_dir)
1516     {
1517       gchar *p;
1518       while ((p = strchr (g_home_dir, '/')) != NULL)
1519         *p = '\\';
1520     }
1521
1522   if (!g_home_dir)
1523     {
1524       /* USERPROFILE is probably the closest equivalent to $HOME? */
1525       if (g_getenv ("USERPROFILE") != NULL)
1526         g_home_dir = g_strdup (g_getenv ("USERPROFILE"));
1527     }
1528
1529   if (!g_home_dir)
1530     g_home_dir = get_special_folder (CSIDL_PROFILE);
1531   
1532   if (!g_home_dir)
1533     g_home_dir = get_windows_directory_root ();
1534 #endif /* G_OS_WIN32 */
1535   
1536 #ifdef HAVE_PWD_H
1537   {
1538     struct passwd *pw = NULL;
1539     gpointer buffer = NULL;
1540     gint error;
1541     gchar *logname;
1542
1543 #  if defined (HAVE_POSIX_GETPWUID_R) || defined (HAVE_NONPOSIX_GETPWUID_R)
1544     struct passwd pwd;
1545 #    ifdef _SC_GETPW_R_SIZE_MAX  
1546     /* This reurns the maximum length */
1547     glong bufsize = sysconf (_SC_GETPW_R_SIZE_MAX);
1548     
1549     if (bufsize < 0)
1550       bufsize = 64;
1551 #    else /* _SC_GETPW_R_SIZE_MAX */
1552     glong bufsize = 64;
1553 #    endif /* _SC_GETPW_R_SIZE_MAX */
1554
1555     logname = (gchar *) g_getenv ("LOGNAME");
1556         
1557     do
1558       {
1559         g_free (buffer);
1560         /* we allocate 6 extra bytes to work around a bug in 
1561          * Mac OS < 10.3. See #156446
1562          */
1563         buffer = g_malloc (bufsize + 6);
1564         errno = 0;
1565         
1566 #    ifdef HAVE_POSIX_GETPWUID_R
1567         if (logname) {
1568           error = getpwnam_r (logname, &pwd, buffer, bufsize, &pw);
1569           if (!pw || (pw->pw_uid != getuid ())) {
1570             /* LOGNAME is lying, fall back to looking up the uid */
1571             error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1572           }
1573         } else {
1574           error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
1575         }
1576         error = error < 0 ? errno : error;
1577 #    else /* HAVE_NONPOSIX_GETPWUID_R */
1578    /* HPUX 11 falls into the HAVE_POSIX_GETPWUID_R case */
1579 #      if defined(_AIX) || defined(__hpux)
1580         error = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1581         pw = error == 0 ? &pwd : NULL;
1582 #      else /* !_AIX */
1583         if (logname) {
1584           pw = getpwnam_r (logname, &pwd, buffer, bufsize);
1585           if (!pw || (pw->pw_uid != getuid ())) {
1586             /* LOGNAME is lying, fall back to looking up the uid */
1587             pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1588           }
1589         } else {
1590           pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
1591         }
1592         error = pw ? 0 : errno;
1593 #      endif /* !_AIX */            
1594 #    endif /* HAVE_NONPOSIX_GETPWUID_R */
1595         
1596         if (!pw)
1597           {
1598             /* we bail out prematurely if the user id can't be found
1599              * (should be pretty rare case actually), or if the buffer
1600              * should be sufficiently big and lookups are still not
1601              * successfull.
1602              */
1603             if (error == 0 || error == ENOENT)
1604               {
1605                 g_warning ("getpwuid_r(): failed due to unknown user id (%lu)",
1606                            (gulong) getuid ());
1607                 break;
1608               }
1609             if (bufsize > 32 * 1024)
1610               {
1611                 g_warning ("getpwuid_r(): failed due to: %s.",
1612                            g_strerror (error));
1613                 break;
1614               }
1615             
1616             bufsize *= 2;
1617           }
1618       }
1619     while (!pw);
1620 #  endif /* HAVE_POSIX_GETPWUID_R || HAVE_NONPOSIX_GETPWUID_R */
1621     
1622     if (!pw)
1623       {
1624         setpwent ();
1625         pw = getpwuid (getuid ());
1626         endpwent ();
1627       }
1628     if (pw)
1629       {
1630         g_user_name = g_strdup (pw->pw_name);
1631
1632         if (pw->pw_gecos && *pw->pw_gecos != '\0') 
1633           {
1634             gchar **gecos_fields;
1635             gchar **name_parts;
1636
1637             /* split the gecos field and substitute '&' */
1638             gecos_fields = g_strsplit (pw->pw_gecos, ",", 0);
1639             name_parts = g_strsplit (gecos_fields[0], "&", 0);
1640             pw->pw_name[0] = g_ascii_toupper (pw->pw_name[0]);
1641             g_real_name = g_strjoinv (pw->pw_name, name_parts);
1642             g_strfreev (gecos_fields);
1643             g_strfreev (name_parts);
1644           }
1645
1646         if (!g_home_dir)
1647           g_home_dir = g_strdup (pw->pw_dir);
1648       }
1649     g_free (buffer);
1650   }
1651   
1652 #else /* !HAVE_PWD_H */
1653   
1654 #ifdef G_OS_WIN32
1655   {
1656     guint len = UNLEN+1;
1657     wchar_t buffer[UNLEN+1];
1658     
1659     if (GetUserNameW (buffer, (LPDWORD) &len))
1660       {
1661         g_user_name = g_utf16_to_utf8 (buffer, -1, NULL, NULL, NULL);
1662         g_real_name = g_strdup (g_user_name);
1663       }
1664   }
1665 #endif /* G_OS_WIN32 */
1666
1667 #endif /* !HAVE_PWD_H */
1668
1669 #ifndef G_OS_WIN32
1670   if (!g_home_dir)
1671     g_home_dir = g_strdup (g_getenv ("HOME"));
1672 #endif
1673
1674 #ifdef __EMX__
1675   /* change '\\' in %HOME% to '/' */
1676   g_strdelimit (g_home_dir, "\\",'/');
1677 #endif
1678   if (!g_user_name)
1679     g_user_name = g_strdup ("somebody");
1680   if (!g_real_name)
1681     g_real_name = g_strdup ("Unknown");
1682
1683   {
1684 #ifndef G_OS_WIN32
1685     gboolean hostname_fail = (gethostname (hostname, sizeof (hostname)) == -1);
1686 #else
1687     DWORD size = sizeof (hostname);
1688     gboolean hostname_fail = (!GetComputerName (hostname, &size));
1689 #endif
1690     g_host_name = g_strdup (hostname_fail ? "localhost" : hostname);
1691   }
1692
1693 #ifdef G_OS_WIN32
1694   g_tmp_dir_cp = g_locale_from_utf8 (g_tmp_dir, -1, NULL, NULL, NULL);
1695   g_user_name_cp = g_locale_from_utf8 (g_user_name, -1, NULL, NULL, NULL);
1696   g_real_name_cp = g_locale_from_utf8 (g_real_name, -1, NULL, NULL, NULL);
1697
1698   if (!g_tmp_dir_cp)
1699     g_tmp_dir_cp = g_strdup ("\\");
1700   if (!g_user_name_cp)
1701     g_user_name_cp = g_strdup ("somebody");
1702   if (!g_real_name_cp)
1703     g_real_name_cp = g_strdup ("Unknown");
1704
1705   /* home_dir might be NULL, unlike tmp_dir, user_name and
1706    * real_name.
1707    */
1708   if (g_home_dir)
1709     g_home_dir_cp = g_locale_from_utf8 (g_home_dir, -1, NULL, NULL, NULL);
1710   else
1711     g_home_dir_cp = NULL;
1712 #endif /* G_OS_WIN32 */
1713 }
1714
1715 static inline void
1716 g_get_any_init (void)
1717 {
1718   if (!g_tmp_dir)
1719     g_get_any_init_do ();
1720 }
1721
1722 static inline void
1723 g_get_any_init_locked (void)
1724 {
1725   G_LOCK (g_utils_global);
1726   g_get_any_init ();
1727   G_UNLOCK (g_utils_global);
1728 }
1729
1730
1731 /**
1732  * g_get_user_name:
1733  *
1734  * Gets the user name of the current user. The encoding of the returned
1735  * string is system-defined. On UNIX, it might be the preferred file name
1736  * encoding, or something else, and there is no guarantee that it is even
1737  * consistent on a machine. On Windows, it is always UTF-8.
1738  *
1739  * Returns: the user name of the current user.
1740  */
1741 G_CONST_RETURN gchar*
1742 g_get_user_name (void)
1743 {
1744   g_get_any_init_locked ();
1745   return g_user_name;
1746 }
1747
1748 /**
1749  * g_get_real_name:
1750  *
1751  * Gets the real name of the user. This usually comes from the user's entry 
1752  * in the <filename>passwd</filename> file. The encoding of the returned 
1753  * string is system-defined. (On Windows, it is, however, always UTF-8.) 
1754  * If the real user name cannot be determined, the string "Unknown" is 
1755  * returned.
1756  *
1757  * Returns: the user's real name.
1758  */
1759 G_CONST_RETURN gchar*
1760 g_get_real_name (void)
1761 {
1762   g_get_any_init_locked ();
1763   return g_real_name;
1764 }
1765
1766 /**
1767  * g_get_home_dir:
1768  *
1769  * Gets the current user's home directory as defined in the 
1770  * password database.
1771  *
1772  * Note that in contrast to traditional UNIX tools, this function 
1773  * prefers <filename>passwd</filename> entries over the <envar>HOME</envar> 
1774  * environment variable.
1775  *
1776  * Returns: the current user's home directory.
1777  */
1778 G_CONST_RETURN gchar*
1779 g_get_home_dir (void)
1780 {
1781   g_get_any_init_locked ();
1782   return g_home_dir;
1783 }
1784
1785 /**
1786  * g_get_tmp_dir:
1787  *
1788  * Gets the directory to use for temporary files. This is found from 
1789  * inspecting the environment variables <envar>TMPDIR</envar>, 
1790  * <envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none 
1791  * of those are defined "/tmp" is returned on UNIX and "C:\" on Windows. 
1792  * The encoding of the returned string is system-defined. On Windows, 
1793  * it is always UTF-8. The return value is never %NULL.
1794  *
1795  * Returns: the directory to use for temporary files.
1796  */
1797 G_CONST_RETURN gchar*
1798 g_get_tmp_dir (void)
1799 {
1800   g_get_any_init_locked ();
1801   return g_tmp_dir;
1802 }
1803
1804 /**
1805  * g_get_host_name:
1806  *
1807  * Return a name for the machine. 
1808  *
1809  * The returned name is not necessarily a fully-qualified domain name,
1810  * or even present in DNS or some other name service at all. It need
1811  * not even be unique on your local network or site, but usually it
1812  * is. Callers should not rely on the return value having any specific
1813  * properties like uniqueness for security purposes. Even if the name
1814  * of the machine is changed while an application is running, the
1815  * return value from this function does not change. The returned
1816  * string is owned by GLib and should not be modified or freed. If no
1817  * name can be determined, a default fixed string "localhost" is
1818  * returned.
1819  *
1820  * Returns: the host name of the machine.
1821  *
1822  * Since: 2.8
1823  */
1824 const gchar *
1825 g_get_host_name (void)
1826 {
1827   g_get_any_init_locked ();
1828   return g_host_name;
1829 }
1830
1831 G_LOCK_DEFINE_STATIC (g_prgname);
1832 static gchar *g_prgname = NULL;
1833
1834 /**
1835  * g_get_prgname:
1836  *
1837  * Gets the name of the program. This name should <emphasis>not</emphasis> 
1838  * be localized, contrast with g_get_application_name().
1839  * (If you are using GDK or GTK+ the program name is set in gdk_init(), 
1840  * which is called by gtk_init(). The program name is found by taking 
1841  * the last component of <literal>argv[0]</literal>.)
1842  *
1843  * Returns: the name of the program. The returned string belongs 
1844  * to GLib and must not be modified or freed.
1845  */
1846 gchar*
1847 g_get_prgname (void)
1848 {
1849   gchar* retval;
1850
1851   G_LOCK (g_prgname);
1852 #ifdef G_OS_WIN32
1853   if (g_prgname == NULL)
1854     {
1855       static gboolean beenhere = FALSE;
1856
1857       if (!beenhere)
1858         {
1859           gchar *utf8_buf = NULL;
1860           wchar_t buf[MAX_PATH+1];
1861
1862           beenhere = TRUE;
1863           if (GetModuleFileNameW (GetModuleHandle (NULL),
1864                                   buf, G_N_ELEMENTS (buf)) > 0)
1865             utf8_buf = g_utf16_to_utf8 (buf, -1, NULL, NULL, NULL);
1866
1867           if (utf8_buf)
1868             {
1869               g_prgname = g_path_get_basename (utf8_buf);
1870               g_free (utf8_buf);
1871             }
1872         }
1873     }
1874 #endif
1875   retval = g_prgname;
1876   G_UNLOCK (g_prgname);
1877
1878   return retval;
1879 }
1880
1881 /**
1882  * g_set_prgname:
1883  * @prgname: the name of the program.
1884  *
1885  * Sets the name of the program. This name should <emphasis>not</emphasis> 
1886  * be localized, contrast with g_set_application_name(). Note that for 
1887  * thread-safety reasons this function can only be called once.
1888  */
1889 void
1890 g_set_prgname (const gchar *prgname)
1891 {
1892   G_LOCK (g_prgname);
1893   g_free (g_prgname);
1894   g_prgname = g_strdup (prgname);
1895   G_UNLOCK (g_prgname);
1896 }
1897
1898 G_LOCK_DEFINE_STATIC (g_application_name);
1899 static gchar *g_application_name = NULL;
1900
1901 /**
1902  * g_get_application_name:
1903  * 
1904  * Gets a human-readable name for the application, as set by
1905  * g_set_application_name(). This name should be localized if
1906  * possible, and is intended for display to the user.  Contrast with
1907  * g_get_prgname(), which gets a non-localized name. If
1908  * g_set_application_name() has not been called, returns the result of
1909  * g_get_prgname() (which may be %NULL if g_set_prgname() has also not
1910  * been called).
1911  * 
1912  * Return value: human-readable application name. may return %NULL
1913  *
1914  * Since: 2.2
1915  **/
1916 G_CONST_RETURN gchar*
1917 g_get_application_name (void)
1918 {
1919   gchar* retval;
1920
1921   G_LOCK (g_application_name);
1922   retval = g_application_name;
1923   G_UNLOCK (g_application_name);
1924
1925   if (retval == NULL)
1926     return g_get_prgname ();
1927   
1928   return retval;
1929 }
1930
1931 /**
1932  * g_set_application_name:
1933  * @application_name: localized name of the application
1934  *
1935  * Sets a human-readable name for the application. This name should be
1936  * localized if possible, and is intended for display to the user.
1937  * Contrast with g_set_prgname(), which sets a non-localized name.
1938  * g_set_prgname() will be called automatically by gtk_init(),
1939  * but g_set_application_name() will not.
1940  *
1941  * Note that for thread safety reasons, this function can only
1942  * be called once.
1943  *
1944  * The application name will be used in contexts such as error messages,
1945  * or when displaying an application's name in the task list.
1946  * 
1947  **/
1948 void
1949 g_set_application_name (const gchar *application_name)
1950 {
1951   gboolean already_set = FALSE;
1952         
1953   G_LOCK (g_application_name);
1954   if (g_application_name)
1955     already_set = TRUE;
1956   else
1957     g_application_name = g_strdup (application_name);
1958   G_UNLOCK (g_application_name);
1959
1960   if (already_set)
1961     g_warning ("g_set_application() name called multiple times");
1962 }
1963
1964 /**
1965  * g_get_user_data_dir:
1966  * 
1967  * Returns a base directory in which to access application data such
1968  * as icons that is customized for a particular user.  
1969  *
1970  * On UNIX platforms this is determined using the mechanisms described in
1971  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
1972  * XDG Base Directory Specification</ulink>
1973  * 
1974  * Return value: a string owned by GLib that must not be modified 
1975  *               or freed.
1976  * Since: 2.6
1977  **/
1978 G_CONST_RETURN gchar*
1979 g_get_user_data_dir (void)
1980 {
1981   gchar *data_dir;  
1982
1983   G_LOCK (g_utils_global);
1984
1985   if (!g_user_data_dir)
1986     {
1987 #ifdef G_OS_WIN32
1988       data_dir = get_special_folder (CSIDL_PERSONAL);
1989 #else
1990       data_dir = (gchar *) g_getenv ("XDG_DATA_HOME");
1991
1992       if (data_dir && data_dir[0])
1993         data_dir = g_strdup (data_dir);
1994 #endif
1995       if (!data_dir || !data_dir[0])
1996         {
1997           g_get_any_init ();
1998
1999           if (g_home_dir)
2000             data_dir = g_build_filename (g_home_dir, ".local", 
2001                                          "share", NULL);
2002           else
2003             data_dir = g_build_filename (g_tmp_dir, g_user_name, ".local", 
2004                                          "share", NULL);
2005         }
2006
2007       g_user_data_dir = data_dir;
2008     }
2009   else
2010     data_dir = g_user_data_dir;
2011
2012   G_UNLOCK (g_utils_global);
2013
2014   return data_dir;
2015 }
2016
2017 static void
2018 g_init_user_config_dir (void)
2019 {
2020   gchar *config_dir;
2021
2022   if (!g_user_config_dir)
2023     {
2024 #ifdef G_OS_WIN32
2025       config_dir = get_special_folder (CSIDL_APPDATA);
2026 #else
2027       config_dir = (gchar *) g_getenv ("XDG_CONFIG_HOME");
2028
2029       if (config_dir && config_dir[0])
2030         config_dir = g_strdup (config_dir);
2031 #endif
2032       if (!config_dir || !config_dir[0])
2033         {
2034           g_get_any_init ();
2035
2036           if (g_home_dir)
2037             config_dir = g_build_filename (g_home_dir, ".config", NULL);
2038           else
2039             config_dir = g_build_filename (g_tmp_dir, g_user_name, ".config", NULL);
2040         }
2041
2042       g_user_config_dir = config_dir;
2043     }
2044 }
2045
2046 /**
2047  * g_get_user_config_dir:
2048  * 
2049  * Returns a base directory in which to store user-specific application 
2050  * configuration information such as user preferences and settings. 
2051  *
2052  * On UNIX platforms this is determined using the mechanisms described in
2053  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2054  * XDG Base Directory Specification</ulink>
2055  * 
2056  * Return value: a string owned by GLib that must not be modified 
2057  *               or freed.
2058  * Since: 2.6
2059  **/
2060 G_CONST_RETURN gchar*
2061 g_get_user_config_dir (void)
2062 {
2063   G_LOCK (g_utils_global);
2064
2065   g_init_user_config_dir ();
2066
2067   G_UNLOCK (g_utils_global);
2068
2069   return g_user_config_dir;
2070 }
2071
2072 /**
2073  * g_get_user_cache_dir:
2074  * 
2075  * Returns a base directory in which to store non-essential, cached
2076  * data specific to particular user.
2077  *
2078  * On UNIX platforms this is determined using the mechanisms described in
2079  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2080  * XDG Base Directory Specification</ulink>
2081  * 
2082  * Return value: a string owned by GLib that must not be modified 
2083  *               or freed.
2084  * Since: 2.6
2085  **/
2086 G_CONST_RETURN gchar*
2087 g_get_user_cache_dir (void)
2088 {
2089   gchar *cache_dir;  
2090
2091   G_LOCK (g_utils_global);
2092
2093   if (!g_user_cache_dir)
2094     {
2095 #ifdef G_OS_WIN32
2096       cache_dir = get_special_folder (CSIDL_INTERNET_CACHE); /* XXX correct? */
2097 #else
2098       cache_dir = (gchar *) g_getenv ("XDG_CACHE_HOME");
2099
2100       if (cache_dir && cache_dir[0])
2101           cache_dir = g_strdup (cache_dir);
2102 #endif
2103       if (!cache_dir || !cache_dir[0])
2104         {
2105           g_get_any_init ();
2106         
2107           if (g_home_dir)
2108             cache_dir = g_build_filename (g_home_dir, ".cache", NULL);
2109           else
2110             cache_dir = g_build_filename (g_tmp_dir, g_user_name, ".cache", NULL);
2111         }
2112       g_user_cache_dir = cache_dir;
2113     }
2114   else
2115     cache_dir = g_user_cache_dir;
2116
2117   G_UNLOCK (g_utils_global);
2118
2119   return cache_dir;
2120 }
2121
2122 #ifdef HAVE_CARBON
2123
2124 static gchar *
2125 find_folder (OSType type)
2126 {
2127   gchar *filename = NULL;
2128   FSRef  found;
2129
2130   if (FSFindFolder (kUserDomain, type, kDontCreateFolder, &found) == noErr)
2131     {
2132       CFURLRef url = CFURLCreateFromFSRef (kCFAllocatorSystemDefault, &found);
2133
2134       if (url)
2135         {
2136           CFStringRef path = CFURLCopyFileSystemPath (url, kCFURLPOSIXPathStyle);
2137
2138           if (path)
2139             {
2140               filename = g_strdup (CFStringGetCStringPtr (path, kCFStringEncodingUTF8));
2141
2142               if (! filename)
2143                 {
2144                   filename = g_new0 (gchar, CFStringGetLength (path) * 3 + 1);
2145
2146                   CFStringGetCString (path, filename,
2147                                       CFStringGetLength (path) * 3 + 1,
2148                                       kCFStringEncodingUTF8);
2149                 }
2150
2151               CFRelease (path);
2152             }
2153
2154           CFRelease (url);
2155         }
2156     }
2157
2158   return filename;
2159 }
2160
2161 static void
2162 load_user_special_dirs (void)
2163 {
2164   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = find_folder (kDesktopFolderType);
2165   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = find_folder (kDocumentsFolderType);
2166   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = find_folder (kDesktopFolderType); /* XXX correct ? */
2167   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = find_folder (kMusicDocumentsFolderType);
2168   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = find_folder (kPictureDocumentsFolderType);
2169   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = NULL;
2170   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = NULL;
2171   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = find_folder (kMovieDocumentsFolderType);
2172 }
2173
2174 #endif /* HAVE_CARBON */
2175
2176 #if defined(G_OS_WIN32)
2177 static void
2178 load_user_special_dirs (void)
2179 {
2180   g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] = get_special_folder (CSIDL_DESKTOPDIRECTORY);
2181   g_user_special_dirs[G_USER_DIRECTORY_DOCUMENTS] = get_special_folder (CSIDL_PERSONAL);
2182   g_user_special_dirs[G_USER_DIRECTORY_DOWNLOAD] = get_special_folder (CSIDL_DESKTOPDIRECTORY); /* XXX correct ? */
2183   g_user_special_dirs[G_USER_DIRECTORY_MUSIC] = get_special_folder (CSIDL_MYMUSIC);
2184   g_user_special_dirs[G_USER_DIRECTORY_PICTURES] = get_special_folder (CSIDL_MYPICTURES);
2185   g_user_special_dirs[G_USER_DIRECTORY_PUBLIC_SHARE] = get_special_folder (CSIDL_COMMON_DOCUMENTS);  /* XXX correct ? */
2186   g_user_special_dirs[G_USER_DIRECTORY_TEMPLATES] = get_special_folder (CSIDL_TEMPLATES);
2187   g_user_special_dirs[G_USER_DIRECTORY_VIDEOS] = get_special_folder (CSIDL_MYVIDEO);
2188 }
2189 #endif /* G_OS_WIN32 */
2190
2191 #if defined(G_OS_WIN32) || defined(HAVE_CARBON)
2192 static void 
2193 maybe_expire_user_special_dirs (void)
2194 {
2195   /* expire the user dirs after G_USER_DIRS_EXPIRE seconds */
2196   time_t now;
2197
2198   time (&now);
2199   if (now > g_user_special_dirs_mtime + G_USER_DIRS_EXPIRE &&
2200       g_user_special_dirs)
2201     {
2202       gint i;
2203
2204       for (i = 0; i < G_USER_N_DIRECTORIES; i++)
2205         g_free (g_user_special_dirs[i]);
2206
2207       g_free (g_user_special_dirs);
2208       g_user_special_dirs = NULL;
2209     }
2210
2211   if (g_user_special_dirs == NULL)
2212     g_user_special_dirs_mtime = now;
2213 }
2214 #endif
2215
2216 #if defined(G_OS_UNIX) && !defined(HAVE_CARBON)
2217
2218 /* expire g_user_special_dirs if the config file
2219  * was modified between different reads
2220  */
2221 static void
2222 maybe_expire_user_special_dirs (void)
2223 {
2224   gchar *config_file;
2225   struct stat stat_buf;
2226   time_t now;
2227
2228   /* don't stat() the file more often than necessary */
2229   time (&now);
2230   if (now < g_user_special_dirs_stat_time + 5)
2231     return;
2232
2233   g_user_special_dirs_stat_time = now;
2234
2235   config_file = g_build_filename (g_user_config_dir,
2236                                   "user-dirs.dirs",
2237                                   NULL);
2238   
2239   if (stat (config_file, &stat_buf) < 0)
2240     goto out;
2241
2242   if (stat_buf.st_mtime != g_user_special_dirs_mtime &&
2243       g_user_special_dirs != NULL)
2244     {
2245       gint i;
2246
2247       for (i = 0; i < G_USER_N_DIRECTORIES; i++)
2248         g_free (g_user_special_dirs[i]);
2249
2250       g_free (g_user_special_dirs);
2251       g_user_special_dirs = NULL;
2252     }
2253
2254     g_user_special_dirs_mtime = stat_buf.st_mtime;
2255
2256 out:
2257   g_free (config_file);
2258 }
2259
2260
2261 static void g_init_user_config_dir (void);
2262
2263 /* adapted from xdg-user-dir-lookup.c
2264  *
2265  * Copyright (C) 2007 Red Hat Inc.
2266  *
2267  * Permission is hereby granted, free of charge, to any person
2268  * obtaining a copy of this software and associated documentation files
2269  * (the "Software"), to deal in the Software without restriction,
2270  * including without limitation the rights to use, copy, modify, merge,
2271  * publish, distribute, sublicense, and/or sell copies of the Software,
2272  * and to permit persons to whom the Software is furnished to do so,
2273  * subject to the following conditions: 
2274  *
2275  * The above copyright notice and this permission notice shall be
2276  * included in all copies or substantial portions of the Software. 
2277  *
2278  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
2279  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
2280  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
2281  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
2282  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
2283  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2284  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2285  * SOFTWARE.
2286  */
2287 static void
2288 load_user_special_dirs (void)
2289 {
2290   gchar *config_file;
2291   gchar *data;
2292   gchar **lines;
2293   gint n_lines, i;
2294   
2295   g_init_user_config_dir ();
2296   config_file = g_build_filename (g_user_config_dir,
2297                                   "user-dirs.dirs",
2298                                   NULL);
2299   
2300   if (!g_file_get_contents (config_file, &data, NULL, NULL))
2301     {
2302       g_free (config_file);
2303       return;
2304     }
2305
2306   lines = g_strsplit (data, "\n", -1);
2307   n_lines = g_strv_length (lines);
2308   g_free (data);
2309   
2310   for (i = 0; i < n_lines; i++)
2311     {
2312       gchar *buffer = lines[i];
2313       gchar *d, *p;
2314       gint len;
2315       gboolean is_relative = FALSE;
2316       GUserDirectory directory;
2317
2318       /* Remove newline at end */
2319       len = strlen (buffer);
2320       if (len > 0 && buffer[len - 1] == '\n')
2321         buffer[len - 1] = 0;
2322       
2323       p = buffer;
2324       while (*p == ' ' || *p == '\t')
2325         p++;
2326       
2327       if (strncmp (p, "XDG_DESKTOP_DIR", strlen ("XDG_DESKTOP_DIR")) == 0)
2328         {
2329           directory = G_USER_DIRECTORY_DESKTOP;
2330           p += strlen ("XDG_DESKTOP_DIR");
2331         }
2332       else if (strncmp (p, "XDG_DOCUMENTS_DIR", strlen ("XDG_DOCUMENTS_DIR")) == 0)
2333         {
2334           directory = G_USER_DIRECTORY_DOCUMENTS;
2335           p += strlen ("XDG_DOCUMENTS_DIR");
2336         }
2337       else if (strncmp (p, "XDG_DOWNLOAD_DIR", strlen ("XDG_DOWNLOAD_DIR")) == 0)
2338         {
2339           directory = G_USER_DIRECTORY_DOWNLOAD;
2340           p += strlen ("XDG_DOWNLOAD_DIR");
2341         }
2342       else if (strncmp (p, "XDG_MUSIC_DIR", strlen ("XDG_MUSIC_DIR")) == 0)
2343         {
2344           directory = G_USER_DIRECTORY_MUSIC;
2345           p += strlen ("XDG_MUSIC_DIR");
2346         }
2347       else if (strncmp (p, "XDG_PICTURES_DIR", strlen ("XDG_PICTURES_DIR")) == 0)
2348         {
2349           directory = G_USER_DIRECTORY_PICTURES;
2350           p += strlen ("XDG_PICTURES_DIR");
2351         }
2352       else if (strncmp (p, "XDG_PUBLICSHARE_DIR", strlen ("XDG_PUBLICSHARE_DIR")) == 0)
2353         {
2354           directory = G_USER_DIRECTORY_PUBLIC_SHARE;
2355           p += strlen ("XDG_PUBLICSHARE_DIR");
2356         }
2357       else if (strncmp (p, "XDG_TEMPLATES_DIR", strlen ("XDG_TEMPLATES_DIR")) == 0)
2358         {
2359           directory = G_USER_DIRECTORY_TEMPLATES;
2360           p += strlen ("XDG_TEMPLATES_DIR");
2361         }
2362       else if (strncmp (p, "XDG_VIDEOS_DIR", strlen ("XDG_VIDEOS_DIR")) == 0)
2363         {
2364           directory = G_USER_DIRECTORY_VIDEOS;
2365           p += strlen ("XDG_VIDEOS_DIR");
2366         }
2367       else
2368         continue;
2369
2370       while (*p == ' ' || *p == '\t')
2371         p++;
2372
2373       if (*p != '=')
2374         continue;
2375       p++;
2376
2377       while (*p == ' ' || *p == '\t')
2378         p++;
2379
2380       if (*p != '"')
2381         continue;
2382       p++;
2383
2384       if (strncmp (p, "$HOME", 5) == 0)
2385         {
2386           p += 5;
2387           is_relative = TRUE;
2388         }
2389       else if (*p != '/')
2390         continue;
2391
2392       d = strrchr (p, '"');
2393       if (!d)
2394         continue;
2395       *d = 0;
2396
2397       d = p;
2398       
2399       /* remove trailing slashes */
2400       len = strlen (d);
2401       if (d[len - 1] == '/')
2402         d[len - 1] = 0;
2403       
2404       if (is_relative)
2405         {
2406           g_get_any_init ();
2407           g_user_special_dirs[directory] = g_build_filename (g_home_dir, d, NULL);
2408         }
2409       else
2410         g_user_special_dirs[directory] = g_strdup (d);
2411     }
2412
2413   g_strfreev (lines);
2414   g_free (config_file);
2415 }
2416
2417 #endif /* G_OS_UNIX && !HAVE_CARBON */
2418
2419 /**
2420  * g_get_user_special_dir:
2421  * @directory: the logical id of special directory
2422  *
2423  * Returns the full path of a special directory using its logical id.
2424  *
2425  * On Unix this is done using the XDG special user directories.
2426  *
2427  * Return value: the path to the specified special directory, or %NULL
2428  *   if the logical id was not found. The returned string is owned by
2429  *   GLib and should not be modified or freed.
2430  *
2431  * Since: 2.14
2432  */
2433 G_CONST_RETURN gchar *
2434 g_get_user_special_dir (GUserDirectory directory)
2435 {
2436   g_return_val_if_fail (directory >= G_USER_DIRECTORY_DESKTOP &&
2437                         directory < G_USER_N_DIRECTORIES, NULL);
2438
2439   G_LOCK (g_utils_global);
2440
2441   maybe_expire_user_special_dirs ();
2442   if (g_user_special_dirs == NULL)
2443     {
2444       g_user_special_dirs = g_new0 (gchar *, G_USER_N_DIRECTORIES);
2445
2446       load_user_special_dirs ();
2447
2448       /* Special-case desktop for historical compatibility */
2449       if (g_user_special_dirs[G_USER_DIRECTORY_DESKTOP] == NULL)
2450         {
2451           g_get_any_init ();
2452           g_user_special_dirs[directory] = g_build_filename (g_home_dir, "Desktop", NULL);
2453         }
2454     }
2455
2456   G_UNLOCK (g_utils_global);
2457
2458   return g_user_special_dirs[directory];
2459 }
2460
2461 #ifdef G_OS_WIN32
2462
2463 #undef g_get_system_data_dirs
2464
2465 static HMODULE
2466 get_module_for_address (gconstpointer address)
2467 {
2468   /* Holds the g_utils_global lock */
2469
2470   static gboolean beenhere = FALSE;
2471   typedef BOOL (WINAPI *t_GetModuleHandleExA) (DWORD, LPCTSTR, HMODULE *);
2472   static t_GetModuleHandleExA p_GetModuleHandleExA = NULL;
2473   HMODULE hmodule;
2474
2475   if (!address)
2476     return NULL;
2477
2478   if (!beenhere)
2479     {
2480       p_GetModuleHandleExA =
2481         (t_GetModuleHandleExA) GetProcAddress (LoadLibrary ("kernel32.dll"),
2482                                                "GetModuleHandleExA");
2483       beenhere = TRUE;
2484     }
2485
2486   if (p_GetModuleHandleExA == NULL ||
2487       !(*p_GetModuleHandleExA) (GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
2488                                 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
2489                                 address, &hmodule))
2490     {
2491       MEMORY_BASIC_INFORMATION mbi;
2492       VirtualQuery (address, &mbi, sizeof (mbi));
2493       hmodule = (HMODULE) mbi.AllocationBase;
2494     }
2495
2496   return hmodule;
2497 }
2498
2499 static gchar *
2500 get_module_share_dir (gconstpointer address)
2501 {
2502   HMODULE hmodule;
2503   gchar *filename = NULL;
2504   gchar *p, *retval;
2505   wchar_t wfilename[MAX_PATH];
2506
2507   hmodule = get_module_for_address (address);
2508   if (hmodule == NULL)
2509     return NULL;
2510
2511   if (GetModuleFileNameW (hmodule, wfilename, G_N_ELEMENTS (wfilename)))
2512     filename = g_utf16_to_utf8 (wfilename, -1, NULL, NULL, NULL);
2513
2514   if (filename == NULL)
2515     return NULL;
2516
2517   if ((p = strrchr (filename, G_DIR_SEPARATOR)) != NULL)
2518     *p = '\0';
2519
2520   p = strrchr (filename, G_DIR_SEPARATOR);
2521   if (p && (g_ascii_strcasecmp (p + 1, "bin") == 0))
2522     *p = '\0';
2523
2524   retval = g_build_filename (filename, "share", NULL);
2525   g_free (filename);
2526
2527   return retval;
2528 }
2529
2530 G_CONST_RETURN gchar * G_CONST_RETURN *
2531 g_win32_get_system_data_dirs_for_module (gconstpointer address)
2532 {
2533   GArray *data_dirs;
2534   HMODULE hmodule;
2535   static GHashTable *per_module_data_dirs = NULL;
2536   gchar **retval;
2537   gchar *p;
2538       
2539   if (address)
2540     {
2541       G_LOCK (g_utils_global);
2542       hmodule = get_module_for_address (address);
2543       if (hmodule != NULL)
2544         {
2545           if (per_module_data_dirs == NULL)
2546             per_module_data_dirs = g_hash_table_new (NULL, NULL);
2547           else
2548             {
2549               retval = g_hash_table_lookup (per_module_data_dirs, hmodule);
2550               
2551               if (retval != NULL)
2552                 {
2553                   G_UNLOCK (g_utils_global);
2554                   return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2555                 }
2556             }
2557         }
2558     }
2559
2560   data_dirs = g_array_new (TRUE, TRUE, sizeof (char *));
2561
2562   /* Documents and Settings\All Users\Application Data */
2563   p = get_special_folder (CSIDL_COMMON_APPDATA);
2564   if (p)
2565     g_array_append_val (data_dirs, p);
2566   
2567   /* Documents and Settings\All Users\Documents */
2568   p = get_special_folder (CSIDL_COMMON_DOCUMENTS);
2569   if (p)
2570     g_array_append_val (data_dirs, p);
2571         
2572   /* Using the above subfolders of Documents and Settings perhaps
2573    * makes sense from a Windows perspective.
2574    *
2575    * But looking at the actual use cases of this function in GTK+
2576    * and GNOME software, what we really want is the "share"
2577    * subdirectory of the installation directory for the package
2578    * our caller is a part of.
2579    *
2580    * The address parameter, if non-NULL, points to a function in the
2581    * calling module. Use that to determine that module's installation
2582    * folder, and use its "share" subfolder.
2583    *
2584    * Additionally, also use the "share" subfolder of the installation
2585    * locations of GLib and the .exe file being run.
2586    *
2587    * To guard against none of the above being what is really wanted,
2588    * callers of this function should have Win32-specific code to look
2589    * up their installation folder themselves, and handle a subfolder
2590    * "share" of it in the same way as the folders returned from this
2591    * function.
2592    */
2593
2594   p = get_module_share_dir (address);
2595   if (p)
2596     g_array_append_val (data_dirs, p);
2597     
2598   p = g_win32_get_package_installation_subdirectory (NULL, dll_name, "share");
2599   if (p)
2600     g_array_append_val (data_dirs, p);
2601   
2602   p = g_win32_get_package_installation_subdirectory (NULL, NULL, "share");
2603   if (p)
2604     g_array_append_val (data_dirs, p);
2605
2606   retval = (gchar **) g_array_free (data_dirs, FALSE);
2607
2608   if (address)
2609     {
2610       if (hmodule != NULL)
2611         g_hash_table_insert (per_module_data_dirs, hmodule, retval);
2612       G_UNLOCK (g_utils_global);
2613     }
2614
2615   return (G_CONST_RETURN gchar * G_CONST_RETURN *) retval;
2616 }
2617
2618 #endif
2619
2620 /**
2621  * g_get_system_data_dirs:
2622  * 
2623  * Returns an ordered list of base directories in which to access 
2624  * system-wide application data.
2625  *
2626  * On UNIX platforms this is determined using the mechanisms described in
2627  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2628  * XDG Base Directory Specification</ulink>
2629  * 
2630  * On Windows the first elements in the list are the Application Data
2631  * and Documents folders for All Users. (These can be determined only
2632  * on Windows 2000 or later and are not present in the list on other
2633  * Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
2634  * CSIDL_COMMON_DOCUMENTS.
2635  *
2636  * Then follows the "share" subfolder in the installation folder for
2637  * the package containing the DLL that calls this function, if it can
2638  * be determined.
2639  * 
2640  * Finally the list contains the "share" subfolder in the installation
2641  * folder for GLib, and in the installation folder for the package the
2642  * application's .exe file belongs to.
2643  *
2644  * The installation folders above are determined by looking up the
2645  * folder where the module (DLL or EXE) in question is located. If the
2646  * folder's name is "bin", its parent is used, otherwise the folder
2647  * itself.
2648  *
2649  * Note that on Windows the returned list can vary depending on where
2650  * this function is called.
2651  *
2652  * Return value: a %NULL-terminated array of strings owned by GLib that must 
2653  *               not be modified or freed.
2654  * Since: 2.6
2655  **/
2656 G_CONST_RETURN gchar * G_CONST_RETURN * 
2657 g_get_system_data_dirs (void)
2658 {
2659   gchar **data_dir_vector;
2660
2661   G_LOCK (g_utils_global);
2662
2663   if (!g_system_data_dirs)
2664     {
2665 #ifdef G_OS_WIN32
2666       data_dir_vector = (gchar **) g_win32_get_system_data_dirs_for_module (NULL);
2667 #else
2668       gchar *data_dirs = (gchar *) g_getenv ("XDG_DATA_DIRS");
2669
2670       if (!data_dirs || !data_dirs[0])
2671           data_dirs = "/usr/local/share/:/usr/share/";
2672
2673       data_dir_vector = g_strsplit (data_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2674 #endif
2675
2676       g_system_data_dirs = data_dir_vector;
2677     }
2678   else
2679     data_dir_vector = g_system_data_dirs;
2680
2681   G_UNLOCK (g_utils_global);
2682
2683   return (G_CONST_RETURN gchar * G_CONST_RETURN *) data_dir_vector;
2684 }
2685
2686 /**
2687  * g_get_system_config_dirs:
2688  * 
2689  * Returns an ordered list of base directories in which to access 
2690  * system-wide configuration information.
2691  *
2692  * On UNIX platforms this is determined using the mechanisms described in
2693  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
2694  * XDG Base Directory Specification</ulink>
2695  * 
2696  * Return value: a %NULL-terminated array of strings owned by GLib that must 
2697  *               not be modified or freed.
2698  * Since: 2.6
2699  **/
2700 G_CONST_RETURN gchar * G_CONST_RETURN *
2701 g_get_system_config_dirs (void)
2702 {
2703   gchar *conf_dirs, **conf_dir_vector;
2704
2705   G_LOCK (g_utils_global);
2706
2707   if (!g_system_config_dirs)
2708     {
2709 #ifdef G_OS_WIN32
2710       conf_dirs = get_special_folder (CSIDL_COMMON_APPDATA);
2711       if (conf_dirs)
2712         {
2713           conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2714           g_free (conf_dirs);
2715         }
2716       else
2717         {
2718           /* Return empty list */
2719           conf_dir_vector = g_strsplit ("", G_SEARCHPATH_SEPARATOR_S, 0);
2720         }
2721 #else
2722       conf_dirs = (gchar *) g_getenv ("XDG_CONFIG_DIRS");
2723
2724       if (!conf_dirs || !conf_dirs[0])
2725           conf_dirs = "/etc/xdg";
2726
2727       conf_dir_vector = g_strsplit (conf_dirs, G_SEARCHPATH_SEPARATOR_S, 0);
2728 #endif
2729
2730       g_system_config_dirs = conf_dir_vector;
2731     }
2732   else
2733     conf_dir_vector = g_system_config_dirs;
2734   G_UNLOCK (g_utils_global);
2735
2736   return (G_CONST_RETURN gchar * G_CONST_RETURN *) conf_dir_vector;
2737 }
2738
2739 #ifndef G_OS_WIN32
2740
2741 static GHashTable *alias_table = NULL;
2742
2743 /* read an alias file for the locales */
2744 static void
2745 read_aliases (gchar *file)
2746 {
2747   FILE *fp;
2748   char buf[256];
2749   
2750   if (!alias_table)
2751     alias_table = g_hash_table_new (g_str_hash, g_str_equal);
2752   fp = fopen (file,"r");
2753   if (!fp)
2754     return;
2755   while (fgets (buf, 256, fp))
2756     {
2757       char *p, *q;
2758
2759       g_strstrip (buf);
2760
2761       /* Line is a comment */
2762       if ((buf[0] == '#') || (buf[0] == '\0'))
2763         continue;
2764
2765       /* Reads first column */
2766       for (p = buf, q = NULL; *p; p++) {
2767         if ((*p == '\t') || (*p == ' ') || (*p == ':')) {
2768           *p = '\0';
2769           q = p+1;
2770           while ((*q == '\t') || (*q == ' ')) {
2771             q++;
2772           }
2773           break;
2774         }
2775       }
2776       /* The line only had one column */
2777       if (!q || *q == '\0')
2778         continue;
2779       
2780       /* Read second column */
2781       for (p = q; *p; p++) {
2782         if ((*p == '\t') || (*p == ' ')) {
2783           *p = '\0';
2784           break;
2785         }
2786       }
2787
2788       /* Add to alias table if necessary */
2789       if (!g_hash_table_lookup (alias_table, buf)) {
2790         g_hash_table_insert (alias_table, g_strdup (buf), g_strdup (q));
2791       }
2792     }
2793   fclose (fp);
2794 }
2795
2796 #endif
2797
2798 static char *
2799 unalias_lang (char *lang)
2800 {
2801 #ifndef G_OS_WIN32
2802   char *p;
2803   int i;
2804
2805   if (!alias_table)
2806     read_aliases ("/usr/share/locale/locale.alias");
2807
2808   i = 0;
2809   while ((p = g_hash_table_lookup (alias_table, lang)) && (strcmp (p, lang) != 0))
2810     {
2811       lang = p;
2812       if (i++ == 30)
2813         {
2814           static gboolean said_before = FALSE;
2815           if (!said_before)
2816             g_warning ("Too many alias levels for a locale, "
2817                        "may indicate a loop");
2818           said_before = TRUE;
2819           return lang;
2820         }
2821     }
2822 #endif
2823   return lang;
2824 }
2825
2826 /* Mask for components of locale spec. The ordering here is from
2827  * least significant to most significant
2828  */
2829 enum
2830 {
2831   COMPONENT_CODESET =   1 << 0,
2832   COMPONENT_TERRITORY = 1 << 1,
2833   COMPONENT_MODIFIER =  1 << 2
2834 };
2835
2836 /* Break an X/Open style locale specification into components
2837  */
2838 static guint
2839 explode_locale (const gchar *locale,
2840                 gchar      **language, 
2841                 gchar      **territory, 
2842                 gchar      **codeset, 
2843                 gchar      **modifier)
2844 {
2845   const gchar *uscore_pos;
2846   const gchar *at_pos;
2847   const gchar *dot_pos;
2848
2849   guint mask = 0;
2850
2851   uscore_pos = strchr (locale, '_');
2852   dot_pos = strchr (uscore_pos ? uscore_pos : locale, '.');
2853   at_pos = strchr (dot_pos ? dot_pos : (uscore_pos ? uscore_pos : locale), '@');
2854
2855   if (at_pos)
2856     {
2857       mask |= COMPONENT_MODIFIER;
2858       *modifier = g_strdup (at_pos);
2859     }
2860   else
2861     at_pos = locale + strlen (locale);
2862
2863   if (dot_pos)
2864     {
2865       mask |= COMPONENT_CODESET;
2866       *codeset = g_strndup (dot_pos, at_pos - dot_pos);
2867     }
2868   else
2869     dot_pos = at_pos;
2870
2871   if (uscore_pos)
2872     {
2873       mask |= COMPONENT_TERRITORY;
2874       *territory = g_strndup (uscore_pos, dot_pos - uscore_pos);
2875     }
2876   else
2877     uscore_pos = dot_pos;
2878
2879   *language = g_strndup (locale, uscore_pos - locale);
2880
2881   return mask;
2882 }
2883
2884 /*
2885  * Compute all interesting variants for a given locale name -
2886  * by stripping off different components of the value.
2887  *
2888  * For simplicity, we assume that the locale is in
2889  * X/Open format: language[_territory][.codeset][@modifier]
2890  *
2891  * TODO: Extend this to handle the CEN format (see the GNUlibc docs)
2892  *       as well. We could just copy the code from glibc wholesale
2893  *       but it is big, ugly, and complicated, so I'm reluctant
2894  *       to do so when this should handle 99% of the time...
2895  */
2896 GSList *
2897 _g_compute_locale_variants (const gchar *locale)
2898 {
2899   GSList *retval = NULL;
2900
2901   gchar *language = NULL;
2902   gchar *territory = NULL;
2903   gchar *codeset = NULL;
2904   gchar *modifier = NULL;
2905
2906   guint mask;
2907   guint i;
2908
2909   g_return_val_if_fail (locale != NULL, NULL);
2910
2911   mask = explode_locale (locale, &language, &territory, &codeset, &modifier);
2912
2913   /* Iterate through all possible combinations, from least attractive
2914    * to most attractive.
2915    */
2916   for (i = 0; i <= mask; i++)
2917     if ((i & ~mask) == 0)
2918       {
2919         gchar *val = g_strconcat (language,
2920                                   (i & COMPONENT_TERRITORY) ? territory : "",
2921                                   (i & COMPONENT_CODESET) ? codeset : "",
2922                                   (i & COMPONENT_MODIFIER) ? modifier : "",
2923                                   NULL);
2924         retval = g_slist_prepend (retval, val);
2925       }
2926
2927   g_free (language);
2928   if (mask & COMPONENT_CODESET)
2929     g_free (codeset);
2930   if (mask & COMPONENT_TERRITORY)
2931     g_free (territory);
2932   if (mask & COMPONENT_MODIFIER)
2933     g_free (modifier);
2934
2935   return retval;
2936 }
2937
2938 /* The following is (partly) taken from the gettext package.
2939    Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.  */
2940
2941 static const gchar *
2942 guess_category_value (const gchar *category_name)
2943 {
2944   const gchar *retval;
2945
2946   /* The highest priority value is the `LANGUAGE' environment
2947      variable.  This is a GNU extension.  */
2948   retval = g_getenv ("LANGUAGE");
2949   if ((retval != NULL) && (retval[0] != '\0'))
2950     return retval;
2951
2952   /* `LANGUAGE' is not set.  So we have to proceed with the POSIX
2953      methods of looking to `LC_ALL', `LC_xxx', and `LANG'.  On some
2954      systems this can be done by the `setlocale' function itself.  */
2955
2956   /* Setting of LC_ALL overwrites all other.  */
2957   retval = g_getenv ("LC_ALL");  
2958   if ((retval != NULL) && (retval[0] != '\0'))
2959     return retval;
2960
2961   /* Next comes the name of the desired category.  */
2962   retval = g_getenv (category_name);
2963   if ((retval != NULL) && (retval[0] != '\0'))
2964     return retval;
2965
2966   /* Last possibility is the LANG environment variable.  */
2967   retval = g_getenv ("LANG");
2968   if ((retval != NULL) && (retval[0] != '\0'))
2969     return retval;
2970
2971 #ifdef G_PLATFORM_WIN32
2972   /* g_win32_getlocale() first checks for LC_ALL, LC_MESSAGES and
2973    * LANG, which we already did above. Oh well. The main point of
2974    * calling g_win32_getlocale() is to get the thread's locale as used
2975    * by Windows and the Microsoft C runtime (in the "English_United
2976    * States" format) translated into the Unixish format.
2977    */
2978   retval = g_win32_getlocale ();
2979   if ((retval != NULL) && (retval[0] != '\0'))
2980     return retval;
2981 #endif  
2982
2983   return NULL;
2984 }
2985
2986 typedef struct _GLanguageNamesCache GLanguageNamesCache;
2987
2988 struct _GLanguageNamesCache {
2989   gchar *languages;
2990   gchar **language_names;
2991 };
2992
2993 static void
2994 language_names_cache_free (gpointer data)
2995 {
2996   GLanguageNamesCache *cache = data;
2997   g_free (cache->languages);
2998   g_strfreev (cache->language_names);
2999   g_free (cache);
3000 }
3001
3002 /**
3003  * g_get_language_names:
3004  * 
3005  * Computes a list of applicable locale names, which can be used to 
3006  * e.g. construct locale-dependent filenames or search paths. The returned 
3007  * list is sorted from most desirable to least desirable and always contains 
3008  * the default locale "C".
3009  *
3010  * For example, if LANGUAGE=de:en_US, then the returned list is
3011  * "de", "en_US", "en", "C".
3012  *
3013  * This function consults the environment variables <envar>LANGUAGE</envar>, 
3014  * <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar> 
3015  * to find the list of locales specified by the user.
3016  * 
3017  * Return value: a %NULL-terminated array of strings owned by GLib 
3018  *    that must not be modified or freed.
3019  *
3020  * Since: 2.6
3021  **/
3022 G_CONST_RETURN gchar * G_CONST_RETURN * 
3023 g_get_language_names (void)
3024 {
3025   static GStaticPrivate cache_private = G_STATIC_PRIVATE_INIT;
3026   GLanguageNamesCache *cache = g_static_private_get (&cache_private);
3027   const gchar *value;
3028
3029   if (!cache)
3030     {
3031       cache = g_new0 (GLanguageNamesCache, 1);
3032       g_static_private_set (&cache_private, cache, language_names_cache_free);
3033     }
3034
3035   value = guess_category_value ("LC_MESSAGES");
3036   if (!value)
3037     value = "C";
3038
3039   if (!(cache->languages && strcmp (cache->languages, value) == 0))
3040     {
3041       gchar **languages;
3042       gchar **alist, **a;
3043       GSList *list, *l;
3044       gint i;
3045
3046       g_free (cache->languages);
3047       g_strfreev (cache->language_names);
3048       cache->languages = g_strdup (value);
3049
3050       alist = g_strsplit (value, ":", 0);
3051       list = NULL;
3052       for (a = alist; *a; a++)
3053         {
3054           gchar *b = unalias_lang (*a);
3055           list = g_slist_concat (list, _g_compute_locale_variants (b));
3056         }
3057       g_strfreev (alist);
3058       list = g_slist_append (list, g_strdup ("C"));
3059
3060       cache->language_names = languages = g_new (gchar *, g_slist_length (list) + 1);
3061       for (l = list, i = 0; l; l = l->next, i++)
3062         languages[i] = l->data;
3063       languages[i] = NULL;
3064
3065       g_slist_free (list);
3066     }
3067
3068   return (G_CONST_RETURN gchar * G_CONST_RETURN *) cache->language_names;
3069 }
3070
3071 /**
3072  * g_direct_hash:
3073  * @v: a #gpointer key
3074  *
3075  * Converts a gpointer to a hash value.
3076  * It can be passed to g_hash_table_new() as the @hash_func parameter, 
3077  * when using pointers as keys in a #GHashTable.
3078  *
3079  * Returns: a hash value corresponding to the key.
3080  */
3081 guint
3082 g_direct_hash (gconstpointer v)
3083 {
3084   return GPOINTER_TO_UINT (v);
3085 }
3086
3087 /**
3088  * g_direct_equal:
3089  * @v1: a key.
3090  * @v2: a key to compare with @v1.
3091  *
3092  * Compares two #gpointer arguments and returns %TRUE if they are equal.
3093  * It can be passed to g_hash_table_new() as the @key_equal_func
3094  * parameter, when using pointers as keys in a #GHashTable.
3095  * 
3096  * Returns: %TRUE if the two keys match.
3097  */
3098 gboolean
3099 g_direct_equal (gconstpointer v1,
3100                 gconstpointer v2)
3101 {
3102   return v1 == v2;
3103 }
3104
3105 /**
3106  * g_int_equal:
3107  * @v1: a pointer to a #gint key.
3108  * @v2: a pointer to a #gint key to compare with @v1.
3109  *
3110  * Compares the two #gint values being pointed to and returns 
3111  * %TRUE if they are equal.
3112  * It can be passed to g_hash_table_new() as the @key_equal_func
3113  * parameter, when using pointers to integers as keys in a #GHashTable.
3114  * 
3115  * Returns: %TRUE if the two keys match.
3116  */
3117 gboolean
3118 g_int_equal (gconstpointer v1,
3119              gconstpointer v2)
3120 {
3121   return *((const gint*) v1) == *((const gint*) v2);
3122 }
3123
3124 /**
3125  * g_int_hash:
3126  * @v: a pointer to a #gint key
3127  *
3128  * Converts a pointer to a #gint to a hash value.
3129  * It can be passed to g_hash_table_new() as the @hash_func parameter, 
3130  * when using pointers to integers values as keys in a #GHashTable.
3131  *
3132  * Returns: a hash value corresponding to the key.
3133  */
3134 guint
3135 g_int_hash (gconstpointer v)
3136 {
3137   return *(const gint*) v;
3138 }
3139
3140 /**
3141  * g_nullify_pointer:
3142  * @nullify_location: the memory address of the pointer.
3143  * 
3144  * Set the pointer at the specified location to %NULL.
3145  **/
3146 void
3147 g_nullify_pointer (gpointer *nullify_location)
3148 {
3149   g_return_if_fail (nullify_location != NULL);
3150
3151   *nullify_location = NULL;
3152 }
3153
3154 /**
3155  * g_get_codeset:
3156  * 
3157  * Get the codeset for the current locale.
3158  * 
3159  * Return value: a newly allocated string containing the name
3160  * of the codeset. This string must be freed with g_free().
3161  **/
3162 gchar *
3163 g_get_codeset (void)
3164 {
3165   const gchar *charset;
3166
3167   g_get_charset (&charset);
3168
3169   return g_strdup (charset);
3170 }
3171
3172 /* This is called from g_thread_init(). It's used to
3173  * initialize some static data in a threadsafe way.
3174  */
3175 void
3176 _g_utils_thread_init (void)
3177 {
3178   g_get_language_names ();
3179 }
3180
3181 #ifdef ENABLE_NLS
3182
3183 #include <libintl.h>
3184
3185 #ifdef G_OS_WIN32
3186
3187 /**
3188  * _glib_get_locale_dir:
3189  *
3190  * Return the path to the lib\locale subfolder of the GLib
3191  * installation folder. The path is in the system codepage. We have to
3192  * use system codepage as bindtextdomain() doesn't have a UTF-8
3193  * interface.
3194  */
3195 static const gchar *
3196 _glib_get_locale_dir (void)
3197 {
3198   gchar *dir, *cp_dir;
3199   gchar *retval = NULL;
3200
3201   dir = g_win32_get_package_installation_directory (GETTEXT_PACKAGE, dll_name);
3202   cp_dir = g_win32_locale_filename_from_utf8 (dir);
3203   g_free (dir);
3204
3205   if (cp_dir)
3206     {
3207       /* Don't use g_build_filename() on pathnames in the system
3208        * codepage. In CJK locales cp_dir might end with a double-byte
3209        * character whose trailing byte is a backslash.
3210        */
3211       retval = g_strconcat (cp_dir, "\\lib\\locale", NULL);
3212       g_free (cp_dir);
3213     }
3214
3215   if (retval)
3216     return retval;
3217   else
3218     return g_strdup ("");
3219 }
3220
3221 #undef GLIB_LOCALE_DIR
3222 #define GLIB_LOCALE_DIR _glib_get_locale_dir ()
3223
3224 #endif /* G_OS_WIN32 */
3225
3226 G_CONST_RETURN gchar *
3227 _glib_gettext (const gchar *str)
3228 {
3229   static gboolean _glib_gettext_initialized = FALSE;
3230
3231   if (!_glib_gettext_initialized)
3232     {
3233       bindtextdomain(GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
3234 #    ifdef HAVE_BIND_TEXTDOMAIN_CODESET
3235       bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
3236 #    endif
3237       _glib_gettext_initialized = TRUE;
3238     }
3239   
3240   return dgettext (GETTEXT_PACKAGE, str);
3241 }
3242
3243 #endif /* ENABLE_NLS */
3244
3245 #ifdef G_OS_WIN32
3246
3247 /* Binary compatibility versions. Not for newly compiled code. */
3248
3249 #undef g_find_program_in_path
3250
3251 gchar*
3252 g_find_program_in_path (const gchar *program)
3253 {
3254   gchar *utf8_program = g_locale_to_utf8 (program, -1, NULL, NULL, NULL);
3255   gchar *utf8_retval = g_find_program_in_path_utf8 (utf8_program);
3256   gchar *retval;
3257
3258   g_free (utf8_program);
3259   if (utf8_retval == NULL)
3260     return NULL;
3261   retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
3262   g_free (utf8_retval);
3263
3264   return retval;
3265 }
3266
3267 #undef g_get_current_dir
3268
3269 gchar*
3270 g_get_current_dir (void)
3271 {
3272   gchar *utf8_dir = g_get_current_dir_utf8 ();
3273   gchar *dir = g_locale_from_utf8 (utf8_dir, -1, NULL, NULL, NULL);
3274   g_free (utf8_dir);
3275   return dir;
3276 }
3277
3278 #undef g_getenv
3279
3280 G_CONST_RETURN gchar*
3281 g_getenv (const gchar *variable)
3282 {
3283   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3284   const gchar *utf8_value = g_getenv_utf8 (utf8_variable);
3285   gchar *value;
3286   GQuark quark;
3287
3288   g_free (utf8_variable);
3289   if (!utf8_value)
3290     return NULL;
3291   value = g_locale_from_utf8 (utf8_value, -1, NULL, NULL, NULL);
3292   quark = g_quark_from_string (value);
3293   g_free (value);
3294
3295   return g_quark_to_string (quark);
3296 }
3297
3298 #undef g_setenv
3299
3300 gboolean
3301 g_setenv (const gchar *variable, 
3302           const gchar *value, 
3303           gboolean     overwrite)
3304 {
3305   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3306   gchar *utf8_value = g_locale_to_utf8 (value, -1, NULL, NULL, NULL);
3307   gboolean retval = g_setenv_utf8 (utf8_variable, utf8_value, overwrite);
3308
3309   g_free (utf8_variable);
3310   g_free (utf8_value);
3311
3312   return retval;
3313 }
3314
3315 #undef g_unsetenv
3316
3317 void
3318 g_unsetenv (const gchar *variable)
3319 {
3320   gchar *utf8_variable = g_locale_to_utf8 (variable, -1, NULL, NULL, NULL);
3321
3322   g_unsetenv_utf8 (utf8_variable);
3323
3324   g_free (utf8_variable);
3325 }
3326
3327 #undef g_get_user_name
3328
3329 G_CONST_RETURN gchar*
3330 g_get_user_name (void)
3331 {
3332   g_get_any_init_locked ();
3333   return g_user_name_cp;
3334 }
3335
3336 #undef g_get_real_name
3337
3338 G_CONST_RETURN gchar*
3339 g_get_real_name (void)
3340 {
3341   g_get_any_init_locked ();
3342   return g_real_name_cp;
3343 }
3344
3345 #undef g_get_home_dir
3346
3347 G_CONST_RETURN gchar*
3348 g_get_home_dir (void)
3349 {
3350   g_get_any_init_locked ();
3351   return g_home_dir_cp;
3352 }
3353
3354 #undef g_get_tmp_dir
3355
3356 G_CONST_RETURN gchar*
3357 g_get_tmp_dir (void)
3358 {
3359   g_get_any_init_locked ();
3360   return g_tmp_dir_cp;
3361 }
3362
3363 #endif
3364
3365 #define __G_UTILS_C__
3366 #include "galiasdef.c"