Merge in current Win32 version. Almost no Unix code touched.
[platform/upstream/glib.git] / 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 G_LOCK_DECLARE_STATIC (g_utils_global);
375
376 static  gchar   *g_tmp_dir = NULL;
377 static  gchar   *g_user_name = NULL;
378 static  gchar   *g_real_name = NULL;
379 static  gchar   *g_home_dir = NULL;
380
381 /* HOLDS: g_utils_global_lock */
382 static void
383 g_get_any_init (void)
384 {
385   if (!g_tmp_dir)
386     {
387 #ifdef HAVE_PWD_H
388       struct passwd *pw;
389 #endif
390
391       g_tmp_dir = g_strdup (g_getenv ("TMPDIR"));
392       if (!g_tmp_dir)
393         g_tmp_dir = g_strdup (g_getenv ("TMP"));
394       if (!g_tmp_dir)
395         g_tmp_dir = g_strdup (g_getenv ("TEMP"));
396       
397 #ifdef P_tmpdir
398       if (!g_tmp_dir)
399         {
400           int k;
401           g_tmp_dir = g_strdup (P_tmpdir);
402           k = strlen (g_tmp_dir);
403           if (g_tmp_dir[k-1] == G_DIR_SEPARATOR)
404             g_tmp_dir[k-1] = '\0';
405         }
406 #endif
407       if (!g_tmp_dir)
408         {
409 #ifndef NATIVE_WIN32
410           g_tmp_dir = g_strdup ("/tmp");
411 #else /* NATIVE_WIN32 */
412           g_tmp_dir = g_strdup ("C:\\");
413 #endif /* NATIVE_WIN32 */
414         }
415       
416 #ifdef NATIVE_WIN32
417       /* The official way to specify a home directory on NT is
418        * the HOMEDRIVE and HOMEPATH environment variables.
419        *
420        * This is inside #ifdef NATIVE_WIN32 because with the cygwin dll,
421        * HOME should be a POSIX style pathname.
422        */
423       
424       if (getenv ("HOMEDRIVE") != NULL && getenv ("HOMEPATH") != NULL)
425         {
426           gchar *homedrive, *homepath;
427
428           homedrive = g_strdup (g_getenv ("HOMEDRIVE"));
429           homepath = g_strdup (g_getenv ("HOMEPATH"));
430
431           g_home_dir = g_strconcat (homedrive, homepath, NULL);
432           g_free (homedrive);
433           g_free (homepath);
434         }
435       if (!g_home_dir)
436         g_home_dir = g_strdup (g_getenv ("HOME"));
437 #else
438       g_home_dir = g_strdup (g_getenv ("HOME"));
439 #endif
440       
441 #ifdef HAVE_PWD_H
442       /* FIXME: we must actually use the getpwuid_r function here, as
443          getpwuid is not MT-safe, but the prototype doesn't seem to be
444          agreed upon on the different systems, i.e. it is
445
446          struct passwd *getpwuid_r(uid_t uid, struct passwd * pwd, 
447                                    char *buffer, int buflen); 
448
449          on solaris, but 
450          
451          int getpwuid_r(uid_t uid, struct passwd *pwd, char *buffer, 
452                         size_t bufsize  struct passwd **result); 
453  
454          on posix. weird. */
455       setpwent ();
456       pw = getpwuid (getuid ());
457       endpwent ();
458       
459       if (pw)
460         {
461           g_user_name = g_strdup (pw->pw_name);
462           g_real_name = g_strdup (pw->pw_gecos);
463           if (!g_home_dir)
464             g_home_dir = g_strdup (pw->pw_dir);
465         }
466 #else /* !HAVE_PWD_H */
467 #  ifdef NATIVE_WIN32
468       {
469         guint len = 17;
470         
471         g_user_name = g_new (gchar, len);
472         
473         if (!GetUserName (g_user_name, &len))
474           {
475             g_free (g_user_name);
476             g_user_name = g_strdup ("somebody");
477             g_real_name = g_strdup ("Unknown");
478           }
479         else
480           g_real_name = g_strdup (g_user_name);
481       }
482 #  else /* !NATIVE_WIN32 */
483       g_user_name = g_strdup ("somebody");
484       g_real_name = g_strdup ("Unknown");
485       g_home_dir = NULL;
486 #  endif /* !NATIVE_WIN32 */
487 #endif /* !HAVE_PWD_H */
488     }  
489 }
490
491 gchar*
492 g_get_user_name (void)
493 {
494   G_LOCK (g_utils_global);
495   if (!g_tmp_dir)
496     g_get_any_init ();
497   G_UNLOCK (g_utils_global);
498   
499   return g_user_name;
500 }
501
502 gchar*
503 g_get_real_name (void)
504 {
505   G_LOCK (g_utils_global);
506   if (!g_tmp_dir)
507     g_get_any_init ();
508   G_UNLOCK (g_utils_global);
509  
510   return g_real_name;
511 }
512
513 /* Return the home directory of the user. If there is a HOME
514  * environment variable, its value is returned, otherwise use some
515  * system-dependent way of finding it out. If no home directory can be
516  * deduced, return NULL.
517  */
518
519 gchar*
520 g_get_home_dir (void)
521 {
522   G_LOCK (g_utils_global);
523   if (!g_tmp_dir)
524     g_get_any_init ();
525   G_UNLOCK (g_utils_global);
526   
527   return g_home_dir;
528 }
529
530 /* Return a directory to be used to store temporary files. This is the
531  * value of the TMPDIR, TMP or TEMP environment variables (they are
532  * checked in that order). If none of those exist, use P_tmpdir from
533  * stdio.h.  If that isn't defined, return "/tmp" on POSIXly systems,
534  * and C:\ on Windows.
535  */
536
537 gchar*
538 g_get_tmp_dir (void)
539 {
540   G_LOCK (g_utils_global);
541   if (!g_tmp_dir)
542     g_get_any_init ();
543   G_UNLOCK (g_utils_global);
544   
545   return g_tmp_dir;
546 }
547
548 static gchar *g_prgname = NULL;
549
550 gchar*
551 g_get_prgname (void)
552 {
553   gchar* retval;
554
555   G_LOCK (g_utils_global);
556   retval = g_prgname;
557   G_UNLOCK (g_utils_global);
558
559   return retval;
560 }
561
562 void
563 g_set_prgname (const gchar *prgname)
564 {
565   gchar *c;
566     
567   G_LOCK (g_utils_global);
568   c = g_prgname;
569   g_prgname = g_strdup (prgname);
570   g_free (c);
571   G_UNLOCK (g_utils_global);
572 }
573
574 guint
575 g_direct_hash (gconstpointer v)
576 {
577   return GPOINTER_TO_UINT (v);
578 }
579
580 gint
581 g_direct_equal (gconstpointer v1,
582                 gconstpointer v2)
583 {
584   return GPOINTER_TO_UINT (v1) == GPOINTER_TO_UINT (v2);
585 }
586
587 gint
588 g_int_equal (gconstpointer v1,
589              gconstpointer v2)
590 {
591   return *((const gint*) v1) == *((const gint*) v2);
592 }
593
594 guint
595 g_int_hash (gconstpointer v)
596 {
597   return *(const gint*) v;
598 }
599
600 #if 0 /* Old IO Channels */
601
602 GIOChannel*
603 g_iochannel_new (gint fd)
604 {
605   GIOChannel *channel = g_new (GIOChannel, 1);
606
607   channel->fd = fd;
608
609 #ifdef NATIVE_WIN32
610   channel->peer = 0;
611   channel->peer_fd = 0;
612   channel->offset = 0;
613   channel->need_wakeups = 0;
614 #endif /* NATIVE_WIN32 */
615
616   return channel;
617 }
618
619 void
620 g_iochannel_free (GIOChannel *channel)
621 {
622   g_return_if_fail (channel != NULL);
623
624   g_free (channel);
625 }
626
627 void
628 g_iochannel_close_and_free (GIOChannel *channel)
629 {
630   g_return_if_fail (channel != NULL);
631
632   close (channel->fd);
633
634   g_iochannel_free (channel);
635 }
636
637 #undef g_iochannel_wakeup_peer
638
639 void
640 g_iochannel_wakeup_peer (GIOChannel *channel)
641 {
642 #ifdef NATIVE_WIN32
643   static guint message = 0;
644 #endif
645
646   g_return_if_fail (channel != NULL);
647
648 #ifdef NATIVE_WIN32
649   if (message == 0)
650     message = RegisterWindowMessage ("gdk-pipe-readable");
651
652 #  if 0
653   g_print ("g_iochannel_wakeup_peer: calling PostThreadMessage (%#x, %d, %d, %d)\n",
654            channel->peer, message, channel->peer_fd, channel->offset);
655 #  endif
656   PostThreadMessage (channel->peer, message,
657                      channel->peer_fd, channel->offset);
658 #endif /* NATIVE_WIN32 */
659 }
660
661 #endif /* Old IO Channels */
662
663 #ifdef NATIVE_WIN32
664 #ifdef _MSC_VER
665
666 int
667 gwin_ftruncate (gint  fd,
668                 guint size)
669 {
670   HANDLE hfile;
671   guint curpos;
672
673   g_return_val_if_fail (fd >= 0, -1);
674   
675   hfile = (HANDLE) _get_osfhandle (fd);
676   curpos = SetFilePointer (hfile, 0, NULL, FILE_CURRENT);
677   if (curpos == 0xFFFFFFFF
678       || SetFilePointer (hfile, size, NULL, FILE_BEGIN) == 0xFFFFFFFF
679       || !SetEndOfFile (hfile))
680     {
681       gint error = GetLastError ();
682
683       switch (error)
684         {
685         case ERROR_INVALID_HANDLE:
686           errno = EBADF;
687           break;
688         default:
689           errno = EIO;
690           break;
691         }
692
693       return -1;
694     }
695
696   return 0;
697 }
698
699 DIR*
700 gwin_opendir (const char *dirname)
701 {
702   DIR *result;
703   gchar *mask;
704   guint k;
705
706   g_return_val_if_fail (dirname != NULL, NULL);
707
708   result = g_new0 (DIR, 1);
709   result->find_file_data = g_new0 (WIN32_FIND_DATA, 1);
710   result->dir_name = g_strdup (dirname);
711   
712   k = strlen (result->dir_name);
713   if (k && result->dir_name[k - 1] == '\\')
714     {
715       result->dir_name[k - 1] = '\0';
716       k--;
717     }
718   mask = g_strdup_printf ("%s\\*", result->dir_name);
719
720   result->find_file_handle = (guint) FindFirstFile (mask,
721                                              (LPWIN32_FIND_DATA) result->find_file_data);
722   g_free (mask);
723
724   if (result->find_file_handle == (guint) INVALID_HANDLE_VALUE)
725     {
726       int error = GetLastError ();
727
728       g_free (result->dir_name);
729       g_free (result->find_file_data);
730       g_free (result);
731       switch (error)
732         {
733         default:
734           errno = EIO;
735           return NULL;
736         }
737     }
738   result->just_opened = TRUE;
739
740   return result;
741 }
742
743 struct dirent*
744 gwin_readdir (DIR *dir)
745 {
746   static struct dirent result;
747
748   g_return_val_if_fail (dir != NULL, NULL);
749
750   if (dir->just_opened)
751     dir->just_opened = FALSE;
752   else
753     {
754       if (!FindNextFile ((HANDLE) dir->find_file_handle,
755                          (LPWIN32_FIND_DATA) dir->find_file_data))
756         {
757           int error = GetLastError ();
758
759           switch (error)
760             {
761             case ERROR_NO_MORE_FILES:
762               return NULL;
763             default:
764               errno = EIO;
765               return NULL;
766             }
767         }
768     }
769   strcpy (result.d_name, g_basename (((LPWIN32_FIND_DATA) dir->find_file_data)->cFileName));
770       
771   return &result;
772 }
773
774 void
775 gwin_rewinddir (DIR *dir)
776 {
777   gchar *mask;
778
779   g_return_if_fail (dir != NULL);
780
781   if (!FindClose ((HANDLE) dir->find_file_handle))
782     g_warning ("gwin_rewinddir(): FindClose() failed\n");
783
784   mask = g_strdup_printf ("%s\\*", dir->dir_name);
785   dir->find_file_handle = (guint) FindFirstFile (mask,
786                                           (LPWIN32_FIND_DATA) dir->find_file_data);
787   g_free (mask);
788
789   if (dir->find_file_handle == (guint) INVALID_HANDLE_VALUE)
790     {
791       int error = GetLastError ();
792
793       switch (error)
794         {
795         default:
796           errno = EIO;
797           return;
798         }
799     }
800   dir->just_opened = TRUE;
801 }  
802
803 gint
804 gwin_closedir (DIR *dir)
805 {
806   g_return_val_if_fail (dir != NULL, -1);
807
808   if (!FindClose ((HANDLE) dir->find_file_handle))
809     {
810       int error = GetLastError ();
811
812       switch (error)
813         {
814         default:
815           errno = EIO; return -1;
816         }
817     }
818
819   g_free (dir->dir_name);
820   g_free (dir->find_file_data);
821   g_free (dir);
822
823   return 0;
824 }
825
826 #endif /* _MSC_VER */
827
828 #endif /* NATIVE_WIN32 */