1a5fad82e0bc70729634a5513f40c40a5d4c478c
[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 Library 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  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library 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  * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include "glibconfig.h"
29
30 #ifdef HAVE_UNISTD_H
31 #include <unistd.h>
32 #endif
33 #include <stdarg.h>
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <errno.h>
38 #ifdef HAVE_PWD_H
39 #include <pwd.h>
40 #endif
41 #include <sys/types.h>
42 #ifdef HAVE_SYS_PARAM_H
43 #include <sys/param.h>
44 #endif
45
46 #ifdef NATIVE_WIN32
47 #  define STRICT                        /* Strict typing, please */
48 #  include <windows.h>
49 #  include <direct.h>
50 #  include <errno.h>
51 #  include <ctype.h>
52 #  ifdef _MSC_VER
53 #    include <io.h>
54 #  endif /* _MSC_VER */
55 #endif /* NATIVE_WIN32 */
56
57 /* implement Glib's inline functions
58  */
59 #define G_INLINE_FUNC extern
60 #define G_CAN_INLINE 1
61 #include "glib.h"
62
63 #ifdef  MAXPATHLEN
64 #define G_PATH_LENGTH   (MAXPATHLEN + 1)
65 #elif   defined (PATH_MAX)
66 #define G_PATH_LENGTH   (PATH_MAX + 1)
67 #else   /* !MAXPATHLEN */
68 #define G_PATH_LENGTH   (2048 + 1)
69 #endif  /* !MAXPATHLEN && !PATH_MAX */
70
71 const guint glib_major_version = GLIB_MAJOR_VERSION;
72 const guint glib_minor_version = GLIB_MINOR_VERSION;
73 const guint glib_micro_version = GLIB_MICRO_VERSION;
74 const guint glib_interface_age = GLIB_INTERFACE_AGE;
75 const guint glib_binary_age = GLIB_BINARY_AGE;
76
77 #if defined (NATIVE_WIN32) && defined (__LCC__)
78 int __stdcall 
79 LibMain (void         *hinstDll,
80          unsigned long dwReason,
81          void         *reserved)
82 {
83   return 1;
84 }
85 #endif /* NATIVE_WIN32 && __LCC__ */
86
87 void
88 g_atexit (GVoidFunc func)
89 {
90   gint result;
91   gchar *error = NULL;
92
93   /* keep this in sync with glib.h */
94
95 #ifdef  G_NATIVE_ATEXIT
96   result = ATEXIT (func);
97   if (result)
98     error = g_strerror (errno);
99 #elif defined (HAVE_ATEXIT)
100 #  ifdef NeXT /* @#%@! NeXTStep */
101   result = !atexit ((void (*)(void)) func);
102   if (result)
103     error = g_strerror (errno);
104 #  else
105   result = atexit ((void (*)(void)) func);
106   if (result)
107     error = g_strerror (errno);
108 #  endif /* NeXT */
109 #elif defined (HAVE_ON_EXIT)
110   result = on_exit ((void (*)(int, void *)) func, NULL);
111   if (result)
112     error = g_strerror (errno);
113 #else
114   result = 0;
115   error = "no implementation";
116 #endif /* G_NATIVE_ATEXIT */
117
118   if (error)
119     g_error ("Could not register atexit() function: %s", error);
120 }
121
122 gint
123 g_snprintf (gchar       *str,
124             gulong       n,
125             gchar const *fmt,
126             ...)
127 {
128 #ifdef  HAVE_VSNPRINTF
129   va_list args;
130   gint retval;
131   
132   va_start (args, fmt);
133   retval = vsnprintf (str, n, fmt, args);
134   va_end (args);
135   
136   return retval;
137 #else   /* !HAVE_VSNPRINTF */
138   gchar *printed;
139   va_list args;
140   
141   va_start (args, fmt);
142   printed = g_strdup_vprintf (fmt, args);
143   va_end (args);
144   
145   strncpy (str, printed, n);
146   str[n-1] = '\0';
147
148   g_free (printed);
149   
150   return strlen (str);
151 #endif  /* !HAVE_VSNPRINTF */
152 }
153
154 gint
155 g_vsnprintf (gchar       *str,
156              gulong       n,
157              gchar const *fmt,
158              va_list      args)
159 {
160 #ifdef  HAVE_VSNPRINTF
161   gint retval;
162   
163   retval = vsnprintf (str, n, fmt, args);
164   
165   return retval;
166 #else   /* !HAVE_VSNPRINTF */
167   gchar *printed;
168   
169   printed = g_strdup_vprintf (fmt, args);
170   strncpy (str, printed, n);
171   str[n-1] = '\0';
172
173   g_free (printed);
174   
175   return strlen (str);
176 #endif /* !HAVE_VSNPRINTF */
177 }
178
179 guint        
180 g_parse_debug_string  (const gchar *string, 
181                        GDebugKey   *keys, 
182                        guint        nkeys)
183 {
184   guint i;
185   guint result = 0;
186   
187   g_return_val_if_fail (string != NULL, 0);
188   
189   if (!g_strcasecmp (string, "all"))
190     {
191       for (i=0; i<nkeys; i++)
192         result |= keys[i].value;
193     }
194   else
195     {
196       gchar *str = g_strdup (string);
197       gchar *p = str;
198       gchar *q;
199       gboolean done = FALSE;
200       
201       while (*p && !done)
202         {
203           q = strchr (p, ':');
204           if (!q)
205             {
206               q = p + strlen(p);
207               done = TRUE;
208             }
209           
210           *q = 0;
211           
212           for (i=0; i<nkeys; i++)
213             if (!g_strcasecmp(keys[i].key, p))
214               result |= keys[i].value;
215           
216           p = q+1;
217         }
218       
219       g_free (str);
220     }
221   
222   return result;
223 }
224
225 gchar*
226 g_basename (const gchar    *file_name)
227 {
228   register gchar *base;
229   
230   g_return_val_if_fail (file_name != NULL, NULL);
231   
232   base = strrchr (file_name, G_DIR_SEPARATOR);
233   if (base)
234     return base + 1;
235
236 #ifdef NATIVE_WIN32
237   if (isalpha (file_name[0]) && file_name[1] == ':')
238     return (gchar*) file_name + 2;
239 #endif /* NATIVE_WIN32 */
240   
241   return (gchar*) file_name;
242 }
243
244 gboolean
245 g_path_is_absolute (const gchar *file_name)
246 {
247   g_return_val_if_fail (file_name != NULL, FALSE);
248   
249   if (file_name[0] == G_DIR_SEPARATOR)
250     return TRUE;
251
252 #ifdef NATIVE_WIN32
253   if (isalpha (file_name[0]) && file_name[1] == ':' && file_name[2] == G_DIR_SEPARATOR)
254     return TRUE;
255 #endif
256
257   return FALSE;
258 }
259
260 gchar*
261 g_path_skip_root (gchar *file_name)
262 {
263   g_return_val_if_fail (file_name != NULL, NULL);
264   
265   if (file_name[0] == G_DIR_SEPARATOR)
266     return file_name + 1;
267
268 #ifdef NATIVE_WIN32
269   if (isalpha (file_name[0]) && file_name[1] == ':' && file_name[2] == G_DIR_SEPARATOR)
270     return file_name + 3;
271 #endif
272
273   return NULL;
274 }
275
276 gchar*
277 g_dirname (const gchar     *file_name)
278 {
279   register gchar *base;
280   register guint len;
281   
282   g_return_val_if_fail (file_name != NULL, NULL);
283   
284   base = strrchr (file_name, G_DIR_SEPARATOR);
285   if (!base)
286     return g_strdup (".");
287   while (base > file_name && *base == G_DIR_SEPARATOR)
288     base--;
289   len = (guint) 1 + base - file_name;
290   
291   base = g_new (gchar, len + 1);
292   g_memmove (base, file_name, len);
293   base[len] = 0;
294   
295   return base;
296 }
297
298 gchar*
299 g_get_current_dir (void)
300 {
301   gchar *buffer;
302   gchar *dir;
303
304   buffer = g_new (gchar, G_PATH_LENGTH);
305   *buffer = 0;
306   
307   /* We don't use getcwd(3) on SUNOS, because, it does a popen("pwd")
308    * and, if that wasn't bad enough, hangs in doing so.
309    */
310 #if     defined (sun) && !defined (__SVR4)
311   dir = getwd (buffer);
312 #else   /* !sun */
313   dir = getcwd (buffer, G_PATH_LENGTH - 1);
314 #endif  /* !sun */
315   
316   if (!dir || !*buffer)
317     {
318       /* hm, should we g_error() out here?
319        * this can happen if e.g. "./" has mode \0000
320        */
321       buffer[0] = G_DIR_SEPARATOR;
322       buffer[1] = 0;
323     }
324
325   dir = g_strdup (buffer);
326   g_free (buffer);
327   
328   return dir;
329 }
330
331 gchar*
332 g_getenv (const gchar *variable)
333 {
334 #ifndef NATIVE_WIN32
335   g_return_val_if_fail (variable != NULL, NULL);
336
337   return getenv (variable);
338 #else
339   gchar *v;
340   guint k;
341   static gchar *p = NULL;
342   static gint l;
343   gchar dummy[2];
344
345   g_return_val_if_fail (variable != NULL, NULL);
346   
347   v = getenv (variable);
348   if (!v)
349     return NULL;
350   
351   /* On Windows NT, it is relatively typical that environment variables
352    * contain references to other environment variables. Handle that by
353    * calling ExpandEnvironmentStrings.
354    */
355
356   /* First check how much space we need */
357   k = ExpandEnvironmentStrings (v, dummy, 2);
358   /* Then allocate that much, and actualy do the expansion */
359   if (p == NULL)
360     {
361       p = g_malloc (k);
362       l = k;
363     }
364   else if (k > l)
365     {
366       p = g_realloc (p, k);
367       l = k;
368     }
369   ExpandEnvironmentStrings (v, p, k);
370   return p;
371 #endif
372 }
373
374
375 G_LOCK_DECLARE_STATIC (g_utils_global);
376
377 static  gchar   *g_tmp_dir = NULL;
378 static  gchar   *g_user_name = NULL;
379 static  gchar   *g_real_name = NULL;
380 static  gchar   *g_home_dir = NULL;
381
382 /* HOLDS: g_utils_global_lock */
383 static void
384 g_get_any_init (void)
385 {
386   if (!g_tmp_dir)
387     {
388       g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
389       if (!g_tmp_dir)
390         g_tmp_dir = g_strdup (g_getenv ("TMP"));
391       if (!g_tmp_dir)
392         g_tmp_dir = g_strdup (g_getenv ("TEMP"));
393       
394 #ifdef P_tmpdir
395       if (!g_tmp_dir)
396         {
397           int k;
398           g_tmp_dir = g_strdup (P_tmpdir);
399           k = strlen (g_tmp_dir);
400           if (g_tmp_dir[k-1] == G_DIR_SEPARATOR)
401             g_tmp_dir[k-1] = '\0';
402         }
403 #endif
404
405       if (!g_tmp_dir)
406         {
407 #ifndef NATIVE_WIN32
408           g_tmp_dir = g_strdup ("/tmp");
409 #else /* NATIVE_WIN32 */
410           g_tmp_dir = g_strdup ("C:\\");
411 #endif /* NATIVE_WIN32 */
412         }
413       
414 #ifdef NATIVE_WIN32
415       /* The official way to specify a home directory on NT is
416        * the HOMEDRIVE and HOMEPATH environment variables.
417        *
418        * This is inside #ifdef NATIVE_WIN32 because with the cygwin dll,
419        * HOME should be a POSIX style pathname.
420        */
421       
422       if (getenv ("HOMEDRIVE") != NULL && getenv ("HOMEPATH") != NULL)
423         {
424           gchar *homedrive, *homepath;
425
426           homedrive = g_strdup (g_getenv ("HOMEDRIVE"));
427           homepath = g_strdup (g_getenv ("HOMEPATH"));
428
429           g_home_dir = g_strconcat (homedrive, homepath, NULL);
430           g_free (homedrive);
431           g_free (homepath);
432         }
433 #endif /* !NATIVE_WIN32 */
434       
435       if (!g_home_dir)
436         g_home_dir = g_strdup (g_getenv ("HOME"));
437       
438       
439 #ifdef HAVE_PWD_H
440       {
441         struct passwd *pw = NULL;
442         gpointer buffer = NULL;
443
444 #  ifdef HAVE_GETPWUID_R
445         struct passwd pwd;
446         guint bufsize = 1; // sizeof (struct passwd);
447         gint error;
448
449         do
450           {
451             g_free (buffer);
452             buffer = g_malloc (bufsize);
453
454 #    ifdef HAVE_GETPWUID_R_POSIX
455             error = getpwuid_r (getuid (), &pwd, buffer, bufsize, &pw);
456             error = error ? errno : 0;
457 #    else /* !HAVE_GETPWUID_R_POSIX */
458             pw = getpwuid_r (getuid (), &pwd, buffer, bufsize);
459             error = errno;
460 #    endif /* !HAVE_GETPWUID_R_POSIX */
461
462             bufsize *= 2;
463           }
464         while (error == ERANGE);
465
466         if (error)
467           g_warning ("getpwuid_r(): failed due to: %s", g_strerror (error));
468
469 #  else /* !HAVE_GETPWUID_R */
470
471 #    ifdef G_THREADS_ENABLED
472 #    warning "the `g_get_(user_name|real_name|home_dir|tmp_dir)'"
473 #    warning "functions will not be MT-safe during their first call"
474 #    warning "because there is no `getpwuid_r' on your system."
475 #    endif /* G_THREADS_ENABLED */
476
477         setpwent ();
478         pw = getpwuid (getuid ());
479         endpwent ();
480
481 #  endif /* !HAVE_GETPWUID_R */
482         
483         if (pw)
484           {
485             g_user_name = g_strdup (pw->pw_name);
486             g_real_name = g_strdup (pw->pw_gecos);
487             if (!g_home_dir)
488               g_home_dir = g_strdup (pw->pw_dir);
489           }
490         g_free (buffer);
491       }
492
493 #else /* !HAVE_PWD_H */
494
495 #  ifdef NATIVE_WIN32
496       {
497         guint len = 17;
498         gchar buffer[17];
499         
500         if (GetUserName (buffer, &len))
501           {
502             g_user_name = g_strdup (buffer);
503             g_real_name = g_strdup (buffer);
504           }
505       }
506 #  else /* !NATIVE_WIN32 */
507       /* why are we forcefully setting g_home_dir to NULL here? */
508       g_free (g_home_dir);
509       g_home_dir = NULL;
510 #  endif /* !NATIVE_WIN32 */
511
512 #endif /* !HAVE_PWD_H */
513
514       if (!g_user_name)
515         g_user_name = g_strdup ("somebody");
516       if (!g_real_name)
517         g_real_name = g_strdup ("Unknown");
518     }  
519 }
520
521 gchar*
522 g_get_user_name (void)
523 {
524   G_LOCK (g_utils_global);
525   if (!g_tmp_dir)
526     g_get_any_init ();
527   G_UNLOCK (g_utils_global);
528   
529   return g_user_name;
530 }
531
532 gchar*
533 g_get_real_name (void)
534 {
535   G_LOCK (g_utils_global);
536   if (!g_tmp_dir)
537     g_get_any_init ();
538   G_UNLOCK (g_utils_global);
539  
540   return g_real_name;
541 }
542
543 /* Return the home directory of the user. If there is a HOME
544  * environment variable, its value is returned, otherwise use some
545  * system-dependent way of finding it out. If no home directory can be
546  * deduced, return NULL.
547  */
548
549 gchar*
550 g_get_home_dir (void)
551 {
552   G_LOCK (g_utils_global);
553   if (!g_tmp_dir)
554     g_get_any_init ();
555   G_UNLOCK (g_utils_global);
556   
557   return g_home_dir;
558 }
559
560 /* Return a directory to be used to store temporary files. This is the
561  * value of the TMPDIR, TMP or TEMP environment variables (they are
562  * checked in that order). If none of those exist, use P_tmpdir from
563  * stdio.h.  If that isn't defined, return "/tmp" on POSIXly systems,
564  * and C:\ on Windows.
565  */
566
567 gchar*
568 g_get_tmp_dir (void)
569 {
570   G_LOCK (g_utils_global);
571   if (!g_tmp_dir)
572     g_get_any_init ();
573   G_UNLOCK (g_utils_global);
574   
575   return g_tmp_dir;
576 }
577
578 static gchar *g_prgname = NULL;
579
580 gchar*
581 g_get_prgname (void)
582 {
583   gchar* retval;
584
585   G_LOCK (g_utils_global);
586   retval = g_prgname;
587   G_UNLOCK (g_utils_global);
588
589   return retval;
590 }
591
592 void
593 g_set_prgname (const gchar *prgname)
594 {
595   gchar *c;
596     
597   G_LOCK (g_utils_global);
598   c = g_prgname;
599   g_prgname = g_strdup (prgname);
600   g_free (c);
601   G_UNLOCK (g_utils_global);
602 }
603
604 guint
605 g_direct_hash (gconstpointer v)
606 {
607   return GPOINTER_TO_UINT (v);
608 }
609
610 gint
611 g_direct_equal (gconstpointer v1,
612                 gconstpointer v2)
613 {
614   return GPOINTER_TO_UINT (v1) == GPOINTER_TO_UINT (v2);
615 }
616
617 gint
618 g_int_equal (gconstpointer v1,
619              gconstpointer v2)
620 {
621   return *((const gint*) v1) == *((const gint*) v2);
622 }
623
624 guint
625 g_int_hash (gconstpointer v)
626 {
627   return *(const gint*) v;
628 }
629
630 #if 0 /* Old IO Channels */
631
632 GIOChannel*
633 g_iochannel_new (gint fd)
634 {
635   GIOChannel *channel = g_new (GIOChannel, 1);
636
637   channel->fd = fd;
638
639 #ifdef NATIVE_WIN32
640   channel->peer = 0;
641   channel->peer_fd = 0;
642   channel->offset = 0;
643   channel->need_wakeups = 0;
644 #endif /* NATIVE_WIN32 */
645
646   return channel;
647 }
648
649 void
650 g_iochannel_free (GIOChannel *channel)
651 {
652   g_return_if_fail (channel != NULL);
653
654   g_free (channel);
655 }
656
657 void
658 g_iochannel_close_and_free (GIOChannel *channel)
659 {
660   g_return_if_fail (channel != NULL);
661
662   close (channel->fd);
663
664   g_iochannel_free (channel);
665 }
666
667 #undef g_iochannel_wakeup_peer
668
669 void
670 g_iochannel_wakeup_peer (GIOChannel *channel)
671 {
672 #ifdef NATIVE_WIN32
673   static guint message = 0;
674 #endif
675
676   g_return_if_fail (channel != NULL);
677
678 #ifdef NATIVE_WIN32
679   if (message == 0)
680     message = RegisterWindowMessage ("gdk-pipe-readable");
681
682 #  if 0
683   g_print ("g_iochannel_wakeup_peer: calling PostThreadMessage (%#x, %d, %d, %d)\n",
684            channel->peer, message, channel->peer_fd, channel->offset);
685 #  endif
686   PostThreadMessage (channel->peer, message,
687                      channel->peer_fd, channel->offset);
688 #endif /* NATIVE_WIN32 */
689 }
690
691 #endif /* Old IO Channels */
692
693 #ifdef NATIVE_WIN32
694 #ifdef _MSC_VER
695
696 int
697 gwin_ftruncate (gint  fd,
698                 guint size)
699 {
700   HANDLE hfile;
701   guint curpos;
702
703   g_return_val_if_fail (fd >= 0, -1);
704   
705   hfile = (HANDLE) _get_osfhandle (fd);
706   curpos = SetFilePointer (hfile, 0, NULL, FILE_CURRENT);
707   if (curpos == 0xFFFFFFFF
708       || SetFilePointer (hfile, size, NULL, FILE_BEGIN) == 0xFFFFFFFF
709       || !SetEndOfFile (hfile))
710     {
711       gint error = GetLastError ();
712
713       switch (error)
714         {
715         case ERROR_INVALID_HANDLE:
716           errno = EBADF;
717           break;
718         default:
719           errno = EIO;
720           break;
721         }
722
723       return -1;
724     }
725
726   return 0;
727 }
728
729 DIR*
730 gwin_opendir (const char *dirname)
731 {
732   DIR *result;
733   gchar *mask;
734   guint k;
735
736   g_return_val_if_fail (dirname != NULL, NULL);
737
738   result = g_new0 (DIR, 1);
739   result->find_file_data = g_new0 (WIN32_FIND_DATA, 1);
740   result->dir_name = g_strdup (dirname);
741   
742   k = strlen (result->dir_name);
743   if (k && result->dir_name[k - 1] == '\\')
744     {
745       result->dir_name[k - 1] = '\0';
746       k--;
747     }
748   mask = g_strdup_printf ("%s\\*", result->dir_name);
749
750   result->find_file_handle = (guint) FindFirstFile (mask,
751                                              (LPWIN32_FIND_DATA) result->find_file_data);
752   g_free (mask);
753
754   if (result->find_file_handle == (guint) INVALID_HANDLE_VALUE)
755     {
756       int error = GetLastError ();
757
758       g_free (result->dir_name);
759       g_free (result->find_file_data);
760       g_free (result);
761       switch (error)
762         {
763         default:
764           errno = EIO;
765           return NULL;
766         }
767     }
768   result->just_opened = TRUE;
769
770   return result;
771 }
772
773 struct dirent*
774 gwin_readdir (DIR *dir)
775 {
776   static struct dirent result;
777
778   g_return_val_if_fail (dir != NULL, NULL);
779
780   if (dir->just_opened)
781     dir->just_opened = FALSE;
782   else
783     {
784       if (!FindNextFile ((HANDLE) dir->find_file_handle,
785                          (LPWIN32_FIND_DATA) dir->find_file_data))
786         {
787           int error = GetLastError ();
788
789           switch (error)
790             {
791             case ERROR_NO_MORE_FILES:
792               return NULL;
793             default:
794               errno = EIO;
795               return NULL;
796             }
797         }
798     }
799   strcpy (result.d_name, g_basename (((LPWIN32_FIND_DATA) dir->find_file_data)->cFileName));
800       
801   return &result;
802 }
803
804 void
805 gwin_rewinddir (DIR *dir)
806 {
807   gchar *mask;
808
809   g_return_if_fail (dir != NULL);
810
811   if (!FindClose ((HANDLE) dir->find_file_handle))
812     g_warning ("gwin_rewinddir(): FindClose() failed\n");
813
814   mask = g_strdup_printf ("%s\\*", dir->dir_name);
815   dir->find_file_handle = (guint) FindFirstFile (mask,
816                                           (LPWIN32_FIND_DATA) dir->find_file_data);
817   g_free (mask);
818
819   if (dir->find_file_handle == (guint) INVALID_HANDLE_VALUE)
820     {
821       int error = GetLastError ();
822
823       switch (error)
824         {
825         default:
826           errno = EIO;
827           return;
828         }
829     }
830   dir->just_opened = TRUE;
831 }  
832
833 gint
834 gwin_closedir (DIR *dir)
835 {
836   g_return_val_if_fail (dir != NULL, -1);
837
838   if (!FindClose ((HANDLE) dir->find_file_handle))
839     {
840       int error = GetLastError ();
841
842       switch (error)
843         {
844         default:
845           errno = EIO; return -1;
846         }
847     }
848
849   g_free (dir->dir_name);
850   g_free (dir->find_file_data);
851   g_free (dir);
852
853   return 0;
854 }
855
856 #endif /* _MSC_VER */
857
858 #endif /* NATIVE_WIN32 */