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