glib/gwin32.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1998  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  * Copyright (C) 1998-1999  Tor Lillqvist
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  23  * file for a list of people on the GLib Team.  See the ChangeLog
  24  * files for a list of changes.  These files are distributed with
  25  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  26  */
  27
  28 /*
  29  * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
  30  */
  31
  32 #include "config.h"
  33
  34 #include "glibconfig.h"
  35
  36 #include <stdlib.h>
  37 #include <stdio.h>
  38 #include <string.h>
  39 #include <wchar.h>
  40 #include <errno.h>
  41
  42 #define STRICT                  /* Strict typing, please */
  43 #include <windows.h>
  44 #undef STRICT
  45 #ifndef G_WITH_CYGWIN
  46 #include <direct.h>
  47 #endif
  48 #include <errno.h>
  49 #include <ctype.h>
  50 #if defined(_MSC_VER) || defined(__DMC__)
  51 #  include <io.h>
  52 #endif /* _MSC_VER || __DMC__ */
  53
  54 #include "glib.h"
  55 #include "galias.h"
  56
  57 #ifdef G_WITH_CYGWIN
  58 #include <sys/cygwin.h>
  59 #endif
  60
  61 #ifndef G_WITH_CYGWIN
  62
  63 gint
  64 g_win32_ftruncate (gint  fd,
  65                    guint size)
  66 {
  67   return _chsize (fd, size);
  68 }
  69
  70 #endif
  71
  72 /**
  73  * g_win32_getlocale:
  74  *
  75  * The setlocale() function in the Microsoft C library uses locale
  76  * names of the form "English_United States.1252" etc. We want the
  77  * UNIXish standard form "en_US", "zh_TW" etc. This function gets the
  78  * current thread locale from Windows - without any encoding info -
  79  * and returns it as a string of the above form for use in forming
  80  * file names etc. The returned string should be deallocated with
  81  * g_free().
  82  *
  83  * Returns: newly-allocated locale name.
  84  **/
  85
  86 #ifndef SUBLANG_SERBIAN_LATIN_BA
  87 #define SUBLANG_SERBIAN_LATIN_BA 0x06
  88 #endif
  89
  90 gchar *
  91 g_win32_getlocale (void)
  92 {
  93   LCID lcid;
  94   LANGID langid;
  95   gchar *ev;
  96   gint primary, sub;
  97   char iso639[10];
  98   char iso3166[10];
  99   const gchar *script = NULL;
 100
 101   /* Let the user override the system settings through environment
 102    * variables, as on POSIX systems. Note that in GTK+ applications
 103    * since GTK+ 2.10.7 setting either LC_ALL or LANG also sets the
 104    * Win32 locale and C library locale through code in gtkmain.c.
 105    */
 106   if (((ev = getenv ("LC_ALL")) != NULL && ev[0] != '\0')
 107       || ((ev = getenv ("LC_MESSAGES")) != NULL && ev[0] != '\0')
 108       || ((ev = getenv ("LANG")) != NULL && ev[0] != '\0'))
 109     return g_strdup (ev);
 110
 111   lcid = GetThreadLocale ();
 112
 113   if (!GetLocaleInfo (lcid, LOCALE_SISO639LANGNAME, iso639, sizeof (iso639)) ||
 114       !GetLocaleInfo (lcid, LOCALE_SISO3166CTRYNAME, iso3166, sizeof (iso3166)))
 115     return g_strdup ("C");
 116
 117   /* Strip off the sorting rules, keep only the language part.  */
 118   langid = LANGIDFROMLCID (lcid);
 119
 120   /* Split into language and territory part.  */
 121   primary = PRIMARYLANGID (langid);
 122   sub = SUBLANGID (langid);
 123
 124   /* Handle special cases */
 125   switch (primary)
 126     {
 127     case LANG_AZERI:
 128       switch (sub)
 129         {
 130         case SUBLANG_AZERI_LATIN:
 131           script = "@Latn";
 132           break;
 133         case SUBLANG_AZERI_CYRILLIC:
 134           script = "@Cyrl";
 135           break;
 136         }
 137       break;
 138     case LANG_SERBIAN:          /* LANG_CROATIAN == LANG_SERBIAN */
 139       switch (sub)
 140         {
 141         case SUBLANG_SERBIAN_LATIN:
 142         case 0x06: /* Serbian (Latin) - Bosnia and Herzegovina */
 143           script = "@Latn";
 144           break;
 145         }
 146       break;
 147     case LANG_UZBEK:
 148       switch (sub)
 149         {
 150         case SUBLANG_UZBEK_LATIN:
 151           script = "@Latn";
 152           break;
 153         case SUBLANG_UZBEK_CYRILLIC:
 154           script = "@Cyrl";
 155           break;
 156         }
 157       break;
 158     }
 159   return g_strconcat (iso639, "_", iso3166, script, NULL);
 160 }
 161
 162 /**
 163  * g_win32_error_message:
 164  * @error: error code.
 165  *
 166  * Translate a Win32 error code (as returned by GetLastError()) into
 167  * the corresponding message. The message is either language neutral,
 168  * or in the thread's language, or the user's language, the system's
 169  * language, or US English (see docs for FormatMessage()). The
 170  * returned string is in UTF-8. It should be deallocated with
 171  * g_free().
 172  *
 173  * Returns: newly-allocated error message
 174  **/
 175 gchar *
 176 g_win32_error_message (gint error)
 177 {
 178   gchar *retval;
 179   wchar_t *msg = NULL;
 180   int nchars;
 181
 182   FormatMessageW (FORMAT_MESSAGE_ALLOCATE_BUFFER
 183                   |FORMAT_MESSAGE_IGNORE_INSERTS
 184                   |FORMAT_MESSAGE_FROM_SYSTEM,
 185                   NULL, error, 0,
 186                   (LPWSTR) &msg, 0, NULL);
 187   if (msg != NULL)
 188     {
 189       nchars = wcslen (msg);
 190
 191       if (nchars > 2 && msg[nchars-1] == '\n' && msg[nchars-2] == '\r')
 192         msg[nchars-2] = '\0';
 193
 194       retval = g_utf16_to_utf8 (msg, -1, NULL, NULL, NULL);
 195
 196       LocalFree (msg);
 197     }
 198   else
 199     retval = g_strdup ("");
 200
 201   return retval;
 202 }
 203
 204 /**
 205  * g_win32_get_package_installation_directory_of_module:
 206  * @hmodule: The Win32 handle for a DLL loaded into the current process, or %NULL
 207  *
 208  * This function tries to determine the installation directory of a
 209  * software package based on the location of a DLL of the software
 210  * package.
 211  *
 212  * @hmodule should be the handle of a loaded DLL or %NULL. The
 213  * function looks up the directory that DLL was loaded from. If
 214  * @hmodule is NULL, the directory the main executable of the current
 215  * process is looked up. If that directory's last component is "bin"
 216  * or "lib", its parent directory is returned, otherwise the directory
 217  * itself.
 218  *
 219  * It thus makes sense to pass only the handle to a "public" DLL of a
 220  * software package to this function, as such DLLs typically are known
 221  * to be installed in a "bin" or occasionally "lib" subfolder of the
 222  * installation folder. DLLs that are of the dynamically loaded module
 223  * or plugin variety are often located in more private locations
 224  * deeper down in the tree, from which it is impossible for GLib to
 225  * deduce the root of the package installation.
 226  *
 227  * The typical use case for this function is to have a DllMain() that
 228  * saves the handle for the DLL. Then when code in the DLL needs to
 229  * construct names of files in the installation tree it calls this
 230  * function passing the DLL handle.
 231  *
 232  * Returns: a string containing the guessed installation directory for
 233  * the software package @hmodule is from. The string is in the GLib
 234  * file name encoding, i.e. UTF-8. The return value should be freed
 235  * with g_free() when not needed any longer. If the function fails
 236  * %NULL is returned.
 237  *
 238  * Since: 2.16
 239  */
 240 gchar *
 241 g_win32_get_package_installation_directory_of_module (gpointer hmodule)
 242 {
 243   gchar *retval;
 244   gchar *p;
 245   wchar_t wc_fn[MAX_PATH];
 246
 247   if (!GetModuleFileNameW (hmodule, wc_fn, MAX_PATH))
 248     return NULL;
 249
 250   retval = g_utf16_to_utf8 (wc_fn, -1, NULL, NULL, NULL);
 251
 252   if ((p = strrchr (retval, G_DIR_SEPARATOR)) != NULL)
 253     *p = '\0';
 254
 255   p = strrchr (retval, G_DIR_SEPARATOR);
 256   if (p && (g_ascii_strcasecmp (p + 1, "bin") == 0 ||
 257             g_ascii_strcasecmp (p + 1, "lib") == 0))
 258     *p = '\0';
 259
 260 #ifdef G_WITH_CYGWIN
 261   /* In Cygwin we need to have POSIX paths */
 262   {
 263     gchar tmp[MAX_PATH];
 264
 265     cygwin_conv_to_posix_path (retval, tmp);
 266     g_free (retval);
 267     retval = g_strdup (tmp);
 268   }
 269 #endif
 270
 271   return retval;
 272 }
 273
 274 static gchar *
 275 get_package_directory_from_module (const gchar *module_name)
 276 {
 277   static GHashTable *module_dirs = NULL;
 278   G_LOCK_DEFINE_STATIC (module_dirs);
 279   HMODULE hmodule = NULL;
 280   gchar *fn;
 281
 282   G_LOCK (module_dirs);
 283
 284   if (module_dirs == NULL)
 285     module_dirs = g_hash_table_new (g_str_hash, g_str_equal);
 286
 287   fn = g_hash_table_lookup (module_dirs, module_name ? module_name : "");
 288
 289   if (fn)
 290     {
 291       G_UNLOCK (module_dirs);
 292       return g_strdup (fn);
 293     }
 294
 295   if (module_name)
 296     {
 297       wchar_t *wc_module_name = g_utf8_to_utf16 (module_name, -1, NULL, NULL, NULL);
 298       hmodule = GetModuleHandleW (wc_module_name);
 299       g_free (wc_module_name);
 300
 301       if (!hmodule)
 302         return NULL;
 303     }
 304
 305   fn = g_win32_get_package_installation_directory_of_module (hmodule);
 306
 307   if (fn == NULL)
 308     return NULL;
 309
 310   g_hash_table_insert (module_dirs, module_name ? g_strdup (module_name) : "", fn);
 311
 312   G_UNLOCK (module_dirs);
 313
 314   return g_strdup (fn);
 315 }
 316
 317 /**
 318  * g_win32_get_package_installation_directory:
 319  * @package: You should pass %NULL for this.
 320  * @dll_name: The name of a DLL that a package provides in UTF-8, or %NULL.
 321  *
 322  * Try to determine the installation directory for a software package.
 323  *
 324  * This function is deprecated. Use
 325  * g_win32_get_package_installation_directory_of_module() instead.
 326  *
 327  * The use of @package is deprecated. You should always pass %NULL. A
 328  * warning is printed if non-NULL is passed as @package.
 329  *
 330  * The original intended use of @package was for a short identifier of
 331  * the package, typically the same identifier as used for
 332  * <literal>GETTEXT_PACKAGE</literal> in software configured using GNU
 333  * autotools. The function first looks in the Windows Registry for the
 334  * value <literal>&num;InstallationDirectory</literal> in the key
 335  * <literal>&num;HKLM\Software\@package</literal>, and if that value
 336  * exists and is a string, returns that.
 337  *
 338  * It is strongly recommended that packagers of GLib-using libraries
 339  * for Windows do not store installation paths in the Registry to be
 340  * used by this function as that interfers with having several
 341  * parallel installations of the library. Enabling multiple
 342  * installations of different versions of some GLib-using library, or
 343  * GLib itself, is desirable for various reasons.
 344  *
 345  * For this reason it is recommeded to always pass %NULL as
 346  * @package to this function, to avoid the temptation to use the
 347  * Registry. In version 2.20 of GLib the @package parameter
 348  * will be ignored and this function won't look in the Registry at all.
 349  *
 350  * If @package is %NULL, or the above value isn't found in the
 351  * Registry, but @dll_name is non-%NULL, it should name a DLL loaded
 352  * into the current process. Typically that would be the name of the
 353  * DLL calling this function, looking for its installation
 354  * directory. The function then asks Windows what directory that DLL
 355  * was loaded from. If that directory's last component is "bin" or
 356  * "lib", the parent directory is returned, otherwise the directory
 357  * itself. If that DLL isn't loaded, the function proceeds as if
 358  * @dll_name was %NULL.
 359  *
 360  * If both @package and @dll_name are %NULL, the directory from where
 361  * the main executable of the process was loaded is used instead in
 362  * the same way as above.
 363  *
 364  * Returns: a string containing the installation directory for
 365  * @package. The string is in the GLib file name encoding,
 366  * i.e. UTF-8. The return value should be freed with g_free() when not
 367  * needed any longer. If the function fails %NULL is returned.
 368  *
 369  * @Deprecated:2.18: Pass the HMODULE of a DLL or EXE to
 370  * g_win32_get_package_installation_directory_of_module() instead.
 371  **/
 372
 373  gchar *
 374 g_win32_get_package_installation_directory_utf8 (const gchar *package,
 375                                                  const gchar *dll_name)
 376 {
 377   static GHashTable *package_dirs = NULL;
 378   G_LOCK_DEFINE_STATIC (package_dirs);
 379   gchar *result = NULL;
 380   gchar *key;
 381   wchar_t *wc_key;
 382   HKEY reg_key = NULL;
 383   DWORD type;
 384   DWORD nbytes;
 385
 386 #if GLIB_CHECK_VERSION (2, 19, 0)
 387   if (package != NULL)
 388       g_warning ("Passing a non-NULL package to g_win32_get_package_installation_directory() is deprecated and it is ignored.");
 389 #else
 390   if (package != NULL)
 391     {
 392       g_warning ("Passing a non-NULL package to g_win32_get_package_installation_directory() is deprecated and will not work in GLib after 2.18.");
 393
 394       G_LOCK (package_dirs);
 395
 396       if (package_dirs == NULL)
 397         package_dirs = g_hash_table_new (g_str_hash, g_str_equal);
 398
 399       result = g_hash_table_lookup (package_dirs, package);
 400
 401       if (result && result[0])
 402         {
 403           G_UNLOCK (package_dirs);
 404           return g_strdup (result);
 405         }
 406
 407       key = g_strconcat ("Software\\", package, NULL);
 408
 409       nbytes = 0;
 410
 411       wc_key = g_utf8_to_utf16 (key, -1, NULL, NULL, NULL);
 412       if (((RegOpenKeyExW (HKEY_CURRENT_USER, wc_key, 0,
 413                            KEY_QUERY_VALUE, &reg_key) == ERROR_SUCCESS
 414             && RegQueryValueExW (reg_key, L"InstallationDirectory", 0,
 415                                  &type, NULL, &nbytes) == ERROR_SUCCESS)
 416            ||
 417            (RegOpenKeyExW (HKEY_LOCAL_MACHINE, wc_key, 0,
 418                            KEY_QUERY_VALUE, &reg_key) == ERROR_SUCCESS
 419             && RegQueryValueExW (reg_key, L"InstallationDirectory", 0,
 420                                  &type, NULL, &nbytes) == ERROR_SUCCESS))
 421           && type == REG_SZ)
 422         {
 423           wchar_t *wc_temp = g_new (wchar_t, (nbytes+1)/2 + 1);
 424           RegQueryValueExW (reg_key, L"InstallationDirectory", 0,
 425                             &type, (LPBYTE) wc_temp, &nbytes);
 426           wc_temp[nbytes/2] = '\0';
 427           result = g_utf16_to_utf8 (wc_temp, -1, NULL, NULL, NULL);
 428           g_free (wc_temp);
 429         }
 430       g_free (wc_key);
 431
 432       if (reg_key != NULL)
 433         RegCloseKey (reg_key);
 434
 435       g_free (key);
 436
 437       if (result)
 438         {
 439           g_hash_table_insert (package_dirs, g_strdup (package), result);
 440           G_UNLOCK (package_dirs);
 441           return g_strdup (result);
 442         }
 443       G_UNLOCK (package_dirs);
 444     }
 445 #endif
 446   if (dll_name != NULL)
 447     result = get_package_directory_from_module (dll_name);
 448
 449   if (result == NULL)
 450     result = get_package_directory_from_module (NULL);
 451
 452   return result;
 453 }
 454
 455 #if !defined (_WIN64)
 456
 457 /* DLL ABI binary compatibility version that uses system codepage file names */
 458
 459 gchar *
 460 g_win32_get_package_installation_directory (const gchar *package,
 461                                             const gchar *dll_name)
 462 {
 463   gchar *utf8_package = NULL, *utf8_dll_name = NULL;
 464   gchar *utf8_retval, *retval;
 465
 466   if (package != NULL)
 467     utf8_package = g_locale_to_utf8 (package, -1, NULL, NULL, NULL);
 468
 469   if (dll_name != NULL)
 470     utf8_dll_name = g_locale_to_utf8 (dll_name, -1, NULL, NULL, NULL);
 471
 472   utf8_retval =
 473     g_win32_get_package_installation_directory_utf8 (utf8_package,
 474                                                      utf8_dll_name);
 475
 476   retval = g_locale_from_utf8 (utf8_retval, -1, NULL, NULL, NULL);
 477
 478   g_free (utf8_package);
 479   g_free (utf8_dll_name);
 480   g_free (utf8_retval);
 481
 482   return retval;
 483 }
 484
 485 #endif
 486
 487 /**
 488  * g_win32_get_package_installation_subdirectory:
 489  * @package: You should pass %NULL for this.
 490  * @dll_name: The name of a DLL that a package provides, in UTF-8, or %NULL.
 491  * @subdir: A subdirectory of the package installation directory, also in UTF-8
 492  *
 493  * This function is deprecated. Use
 494  * g_win32_get_package_installation_directory_of_module() and
 495  * g_build_filename() instead.
 496  *
 497  * Returns a newly-allocated string containing the path of the
 498  * subdirectory @subdir in the return value from calling
 499  * g_win32_get_package_installation_directory() with the @package and
 500  * @dll_name parameters. See the documentation for
 501  * g_win32_get_package_installation_directory() for more details. In
 502  * particular, note that it is deprecated to pass anything except NULL
 503  * as @package.
 504  *
 505  * Returns: a string containing the complete path to @subdir inside
 506  * the installation directory of @package. The returned string is in
 507  * the GLib file name encoding, i.e. UTF-8. The return value should be
 508  * freed with g_free() when no longer needed. If something goes wrong,
 509  * %NULL is returned.
 510  *
 511  * @Deprecated:2.18: Pass the HMODULE of a DLL or EXE to
 512  * g_win32_get_package_installation_directory_of_module() instead, and
 513  * then construct a subdirectory pathname with g_build_filename().
 514  **/
 515
 516 gchar *
 517 g_win32_get_package_installation_subdirectory_utf8 (const gchar *package,
 518                                                     const gchar *dll_name,
 519                                                     const gchar *subdir)
 520 {
 521   gchar *prefix;
 522   gchar *dirname;
 523
 524   prefix = g_win32_get_package_installation_directory_utf8 (package, dll_name);
 525
 526   dirname = g_build_filename (prefix, subdir, NULL);
 527   g_free (prefix);
 528
 529   return dirname;
 530 }
 531
 532 #if !defined (_WIN64)
 533
 534 /* DLL ABI binary compatibility version that uses system codepage file names */
 535
 536 gchar *
 537 g_win32_get_package_installation_subdirectory (const gchar *package,
 538                                                const gchar *dll_name,
 539                                                const gchar *subdir)
 540 {
 541   gchar *prefix;
 542   gchar *dirname;
 543
 544   prefix = g_win32_get_package_installation_directory (package, dll_name);
 545
 546   dirname = g_build_filename (prefix, subdir, NULL);
 547   g_free (prefix);
 548
 549   return dirname;
 550 }
 551
 552 #endif
 553
 554 static guint windows_version;
 555
 556 static void
 557 g_win32_windows_version_init (void)
 558 {
 559   static gboolean beenhere = FALSE;
 560
 561   if (!beenhere)
 562     {
 563       beenhere = TRUE;
 564       windows_version = GetVersion ();
 565
 566       if (windows_version & 0x80000000)
 567         g_error ("This version of GLib requires NT-based Windows.");
 568     }
 569 }
 570
 571 void
 572 _g_win32_thread_init (void)
 573 {
 574   g_win32_windows_version_init ();
 575 }
 576
 577 /**
 578  * g_win32_get_windows_version:
 579  *
 580  * Returns version information for the Windows operating system the
 581  * code is running on. See MSDN documentation for the GetVersion()
 582  * function. To summarize, the most significant bit is one on Win9x,
 583  * and zero on NT-based systems. Since version 2.14, GLib works only
 584  * on NT-based systems, so checking whether your are running on Win9x
 585  * in your own software is moot. The least significant byte is 4 on
 586  * Windows NT 4, and 5 on Windows XP. Software that needs really
 587  * detailled version and feature information should use Win32 API like
 588  * GetVersionEx() and VerifyVersionInfo().
 589  *
 590  * Returns: The version information.
 591  *
 592  * Since: 2.6
 593  **/
 594 guint
 595 g_win32_get_windows_version (void)
 596 {
 597   g_win32_windows_version_init ();
 598
 599   return windows_version;
 600 }
 601
 602 /**
 603  * g_win32_locale_filename_from_utf8:
 604  * @utf8filename: a UTF-8 encoded filename.
 605  *
 606  * Converts a filename from UTF-8 to the system codepage.
 607  *
 608  * On NT-based Windows, on NTFS file systems, file names are in
 609  * Unicode. It is quite possible that Unicode file names contain
 610  * characters not representable in the system codepage. (For instance,
 611  * Greek or Cyrillic characters on Western European or US Windows
 612  * installations, or various less common CJK characters on CJK Windows
 613  * installations.)
 614  *
 615  * In such a case, and if the filename refers to an existing file, and
 616  * the file system stores alternate short (8.3) names for directory
 617  * entries, the short form of the filename is returned. Note that the
 618  * "short" name might in fact be longer than the Unicode name if the
 619  * Unicode name has very short pathname components containing
 620  * non-ASCII characters. If no system codepage name for the file is
 621  * possible, %NULL is returned.
 622  *
 623  * The return value is dynamically allocated and should be freed with
 624  * g_free() when no longer needed.
 625  *
 626  * Return value: The converted filename, or %NULL on conversion
 627  * failure and lack of short names.
 628  *
 629  * Since: 2.8
 630  */
 631 gchar *
 632 g_win32_locale_filename_from_utf8 (const gchar *utf8filename)
 633 {
 634   gchar *retval = g_locale_from_utf8 (utf8filename, -1, NULL, NULL, NULL);
 635
 636   if (retval == NULL)
 637     {
 638       /* Conversion failed, so convert to wide chars, check if there
 639        * is a 8.3 version, and use that.
 640        */
 641       wchar_t *wname = g_utf8_to_utf16 (utf8filename, -1, NULL, NULL, NULL);
 642       if (wname != NULL)
 643         {
 644           wchar_t wshortname[MAX_PATH + 1];
 645           if (GetShortPathNameW (wname, wshortname, G_N_ELEMENTS (wshortname)))
 646             {
 647               gchar *tem = g_utf16_to_utf8 (wshortname, -1, NULL, NULL, NULL);
 648               retval = g_locale_from_utf8 (tem, -1, NULL, NULL, NULL);
 649               g_free (tem);
 650             }
 651           g_free (wname);
 652         }
 653     }
 654   return retval;
 655 }
 656
 657 #define __G_WIN32_C__
 658 #include "galiasdef.c"