Document G_TYPE_HASH_TABLE.
[platform/upstream/glib.git] / glib / gwin32.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  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 #ifndef __G_WIN32_H__
28 #define __G_WIN32_H__
29
30 #include <glib/gtypes.h>
31
32 #ifdef G_PLATFORM_WIN32
33
34 G_BEGIN_DECLS
35
36 #ifndef MAXPATHLEN
37 #define MAXPATHLEN 1024
38 #endif
39
40 #ifdef G_OS_WIN32
41
42 /*
43  * To get prototypes for the following POSIXish functions, you have to
44  * include the indicated non-POSIX headers. The functions are defined
45  * in OLDNAMES.LIB (MSVC) or -lmoldname-msvc (mingw32).
46  *
47  * getcwd: <direct.h> (MSVC), <io.h> (mingw32)
48  * getpid: <process.h>
49  * access: <io.h>
50  * unlink: <stdio.h> or <io.h>
51  * open, read, write, lseek, close: <io.h>
52  * rmdir: <io.h>
53  * pipe: <io.h>
54  */
55
56 /* pipe is not in OLDNAMES.LIB or -lmoldname-msvc. */
57 #define pipe(phandles)  _pipe (phandles, 4096, _O_BINARY)
58
59 /* For some POSIX functions that are not provided by the MS runtime,
60  * we provide emulation functions in glib, which are prefixed with
61  * g_win32_. Or that was the idea at some time, but there is just one
62  * of those:
63  */
64 gint            g_win32_ftruncate       (gint            f,
65                                          guint           size);
66 #endif /* G_OS_WIN32 */
67
68 /* The MS setlocale uses locale names of the form "English_United
69  * States.1252" etc. We want the Unixish standard form "en", "zh_TW"
70  * etc. This function gets the current thread locale from Windows and
71  * returns it as a string of the above form for use in forming file
72  * names etc. The returned string should be deallocated with g_free().
73  */
74 gchar*          g_win32_getlocale  (void);
75
76 /* Translate a Win32 error code (as returned by GetLastError()) into
77  * the corresponding message. The returned string should be deallocated
78  * with g_free().
79  */
80 gchar*          g_win32_error_message (gint error);
81
82 #define g_win32_get_package_installation_directory g_win32_get_package_installation_directory_utf8
83 #define g_win32_get_package_installation_subdirectory g_win32_get_package_installation_subdirectory_utf8
84
85 gchar*          g_win32_get_package_installation_directory (gchar *package,
86                                                             gchar *dll_name);
87
88 gchar*          g_win32_get_package_installation_subdirectory (gchar *package,
89                                                                gchar *dll_name,
90                                                                gchar *subdir);
91
92 guint           g_win32_get_windows_version (void);
93
94 gchar*          g_win32_locale_filename_from_utf8 (const gchar *utf8filename);
95
96 #define G_WIN32_IS_NT_BASED() (g_win32_get_windows_version () < 0x80000000)
97 #define G_WIN32_HAVE_WIDECHAR_API() (G_WIN32_IS_NT_BASED ())
98
99 G_END_DECLS
100
101 #endif   /* G_PLATFORM_WIN32 */
102
103 #endif /* __G_WIN32_H__ */