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