copy of docs from 2.4x for python modules that have been kept
[blender.git] / source / blender / blenlib / BLI_winstuff.h
1 /**
2  * Compatibility-like things for windows.
3  *
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31  
32 #ifndef __WINSTUFF_H__
33 #define __WINSTUFF_H__
34
35 #ifndef FREE_WINDOWS
36 #pragma warning(once: 4761 4305 4244 4018)
37 #endif
38
39 #define WIN32_LEAN_AND_MEAN
40
41 #ifndef WIN32_SKIP_HKEY_PROTECTION
42 #define HKEY WIN32_HKEY                         // prevent competing definitions
43 #include <windows.h>
44 #undef HKEY
45 #else
46 #include <windows.h>
47 #endif
48
49 #undef near
50 #undef far
51 #undef rad
52 #undef rad1
53 #undef rad2
54 #undef rad3
55 #undef vec
56 #undef rect
57 #undef rct1
58 #undef rct2
59
60 #define near clipsta
61 #define far clipend
62
63 #undef small
64
65 // These definitions are also in arithb for simplicity
66
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70
71 #define _USE_MATH_DEFINES
72 #define MAXPATHLEN MAX_PATH
73
74 #ifndef S_ISREG
75 #define S_ISREG(x) ((x&S_IFMT) == S_IFREG)
76 #endif
77 #ifndef S_ISDIR
78 #define S_ISDIR(x) ((x&S_IFMT) == S_IFDIR)
79 #endif
80
81 /* defines for using ISO C++ conformant names */
82 #define open _open
83 #define close _close
84 #define write _write
85 #define read _read
86 #define getcwd _getcwd
87 #define chdir _chdir
88 #define strdup _strdup
89 #define lseek _lseek
90 #define getpid _getpid
91 #define snprintf _snprintf
92
93 #ifndef FREE_WINDOWS
94 typedef unsigned int mode_t;
95 #endif
96
97 /* mingw using _SSIZE_T_ to declare ssize_t type */
98 #ifndef _SSIZE_T_
99 #define _SSIZE_T_
100 /* python uses HAVE_SSIZE_T */
101 #ifndef HAVE_SSIZE_T
102 #define HAVE_SSIZE_T 1
103 typedef long ssize_t;
104 #endif
105 #endif
106
107 struct dirent {
108         int d_ino;
109         int d_off;
110         unsigned short d_reclen;
111         char *d_name;
112 };
113
114 typedef struct _DIR {
115         HANDLE handle;
116         WIN32_FIND_DATA data;
117         char path[MAX_PATH];
118         long dd_loc;
119         long dd_size;
120         char dd_buf[4096];
121         void *dd_direct;
122         
123         struct dirent direntry;
124 } DIR;
125
126 void RegisterBlendExtension(char * str);
127 DIR *opendir (const char *path);
128 struct dirent *readdir(DIR *dp);
129 int closedir (DIR *dp);
130 void get_default_root(char *root);
131 int check_file_chars(char *filename);
132 char *dirname(char *path);
133
134 #ifdef WIN32
135 int BLI_getInstallationDir(char *str);
136 #endif
137
138 #ifdef __cplusplus
139 }
140 #endif
141
142 #endif /* __WINSTUFF_H__ */
143