Win32: Unicode file name support (dirent)
[git.git] / compat / mingw.h
blob405c08fcc36cb9af9fd7266a9d0fca86d074e3d4
1 #include <winsock2.h>
2 #include <ws2tcpip.h>
4 /*
5 * things that are not available in header files
6 */
8 typedef int pid_t;
9 typedef int uid_t;
10 typedef int socklen_t;
11 #define hstrerror strerror
13 #define S_IFLNK 0120000 /* Symbolic link */
14 #define S_ISLNK(x) (((x) & S_IFMT) == S_IFLNK)
15 #define S_ISSOCK(x) 0
17 #define S_IRGRP 0
18 #define S_IWGRP 0
19 #define S_IXGRP 0
20 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
21 #define S_IROTH 0
22 #define S_IWOTH 0
23 #define S_IXOTH 0
24 #define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
26 #define S_ISUID 0004000
27 #define S_ISGID 0002000
28 #define S_ISVTX 0001000
30 #define WIFEXITED(x) 1
31 #define WIFSIGNALED(x) 0
32 #define WEXITSTATUS(x) ((x) & 0xff)
33 #define WTERMSIG(x) SIGTERM
35 #ifndef EWOULDBLOCK
36 #define EWOULDBLOCK EAGAIN
37 #endif
38 #define SHUT_WR SD_SEND
40 #define SIGHUP 1
41 #define SIGQUIT 3
42 #define SIGKILL 9
43 #define SIGPIPE 13
44 #define SIGALRM 14
45 #define SIGCHLD 17
47 #define F_GETFD 1
48 #define F_SETFD 2
49 #define FD_CLOEXEC 0x1
51 #ifndef EAFNOSUPPORT
52 #define EAFNOSUPPORT WSAEAFNOSUPPORT
53 #endif
54 #ifndef ECONNABORTED
55 #define ECONNABORTED WSAECONNABORTED
56 #endif
58 struct passwd {
59 char *pw_name;
60 char *pw_gecos;
61 char *pw_dir;
64 typedef void (__cdecl *sig_handler_t)(int);
65 struct sigaction {
66 sig_handler_t sa_handler;
67 unsigned sa_flags;
69 #define sigemptyset(x) (void)0
70 #define SA_RESTART 0
72 struct itimerval {
73 struct timeval it_value, it_interval;
75 #define ITIMER_REAL 0
78 * sanitize preprocessor namespace polluted by Windows headers defining
79 * macros which collide with git local versions
81 #undef HELP_COMMAND /* from winuser.h */
84 * trivial stubs
87 static inline int readlink(const char *path, char *buf, size_t bufsiz)
88 { errno = ENOSYS; return -1; }
89 static inline int symlink(const char *oldpath, const char *newpath)
90 { errno = ENOSYS; return -1; }
91 static inline int fchmod(int fildes, mode_t mode)
92 { errno = ENOSYS; return -1; }
93 static inline pid_t fork(void)
94 { errno = ENOSYS; return -1; }
95 static inline unsigned int alarm(unsigned int seconds)
96 { return 0; }
97 static inline int fsync(int fd)
98 { return _commit(fd); }
99 static inline pid_t getppid(void)
100 { return 1; }
101 static inline void sync(void)
103 static inline uid_t getuid(void)
104 { return 1; }
105 static inline struct passwd *getpwnam(const char *name)
106 { return NULL; }
107 static inline int fcntl(int fd, int cmd, ...)
109 if (cmd == F_GETFD || cmd == F_SETFD)
110 return 0;
111 errno = EINVAL;
112 return -1;
114 /* bash cannot reliably detect negative return codes as failure */
115 #define exit(code) exit((code) & 0xff)
118 * simple adaptors
121 int mingw_mkdir(const char *path, int mode);
122 #define mkdir mingw_mkdir
124 #define WNOHANG 1
125 pid_t waitpid(pid_t pid, int *status, int options);
127 #define kill mingw_kill
128 int mingw_kill(pid_t pid, int sig);
130 #ifndef NO_OPENSSL
131 #include <openssl/ssl.h>
132 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
134 return SSL_set_fd(ssl, _get_osfhandle(fd));
136 #define SSL_set_fd mingw_SSL_set_fd
138 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
140 return SSL_set_rfd(ssl, _get_osfhandle(fd));
142 #define SSL_set_rfd mingw_SSL_set_rfd
144 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
146 return SSL_set_wfd(ssl, _get_osfhandle(fd));
148 #define SSL_set_wfd mingw_SSL_set_wfd
149 #endif
152 * implementations of missing functions
155 int pipe(int filedes[2]);
156 unsigned int sleep (unsigned int seconds);
157 int mkstemp(char *template);
158 int gettimeofday(struct timeval *tv, void *tz);
159 struct tm *gmtime_r(const time_t *timep, struct tm *result);
160 struct tm *localtime_r(const time_t *timep, struct tm *result);
161 int getpagesize(void); /* defined in MinGW's libgcc.a */
162 struct passwd *getpwuid(uid_t uid);
163 int setitimer(int type, struct itimerval *in, struct itimerval *out);
164 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
165 int link(const char *oldpath, const char *newpath);
168 * replacements of existing functions
171 int mingw_unlink(const char *pathname);
172 #define unlink mingw_unlink
174 int mingw_rmdir(const char *path);
175 #define rmdir mingw_rmdir
177 int mingw_open (const char *filename, int oflags, ...);
178 #define open mingw_open
180 int mingw_fgetc(FILE *stream);
181 #define fgetc mingw_fgetc
183 FILE *mingw_fopen (const char *filename, const char *otype);
184 #define fopen mingw_fopen
186 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
187 #define freopen mingw_freopen
189 int mingw_fflush(FILE *stream);
190 #define fflush mingw_fflush
192 int mingw_access(const char *filename, int mode);
193 #undef access
194 #define access mingw_access
196 int mingw_chdir(const char *dirname);
197 #define chdir mingw_chdir
199 int mingw_chmod(const char *filename, int mode);
200 #define chmod mingw_chmod
202 char *mingw_mktemp(char *template);
203 #define mktemp mingw_mktemp
205 char *mingw_getcwd(char *pointer, int len);
206 #define getcwd mingw_getcwd
208 char *mingw_getenv(const char *name);
209 #define getenv mingw_getenv
211 int mingw_gethostname(char *host, int namelen);
212 #define gethostname mingw_gethostname
214 struct hostent *mingw_gethostbyname(const char *host);
215 #define gethostbyname mingw_gethostbyname
217 void mingw_freeaddrinfo(struct addrinfo *res);
218 #define freeaddrinfo mingw_freeaddrinfo
220 int mingw_getaddrinfo(const char *node, const char *service,
221 const struct addrinfo *hints, struct addrinfo **res);
222 #define getaddrinfo mingw_getaddrinfo
224 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
225 char *host, DWORD hostlen, char *serv, DWORD servlen,
226 int flags);
227 #define getnameinfo mingw_getnameinfo
229 int mingw_socket(int domain, int type, int protocol);
230 #define socket mingw_socket
232 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
233 #define connect mingw_connect
235 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
236 #define bind mingw_bind
238 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
239 #define setsockopt mingw_setsockopt
241 int mingw_shutdown(int sockfd, int how);
242 #define shutdown mingw_shutdown
244 int mingw_listen(int sockfd, int backlog);
245 #define listen mingw_listen
247 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
248 #define accept mingw_accept
250 int mingw_rename(const char*, const char*);
251 #define rename mingw_rename
253 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
254 int mingw_getpagesize(void);
255 #define getpagesize mingw_getpagesize
256 #endif
258 struct rlimit {
259 unsigned int rlim_cur;
261 #define RLIMIT_NOFILE 0
263 static inline int getrlimit(int resource, struct rlimit *rlp)
265 if (resource != RLIMIT_NOFILE) {
266 errno = EINVAL;
267 return -1;
270 rlp->rlim_cur = 2048;
271 return 0;
275 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
277 #define off_t off64_t
278 #define lseek _lseeki64
280 /* use struct stat with 64 bit st_size */
281 #ifdef stat
282 #undef stat
283 #endif
284 #define stat _stati64
285 int mingw_lstat(const char *file_name, struct stat *buf);
286 int mingw_stat(const char *file_name, struct stat *buf);
287 int mingw_fstat(int fd, struct stat *buf);
288 #ifdef fstat
289 #undef fstat
290 #endif
291 #define fstat mingw_fstat
292 #ifdef lstat
293 #undef lstat
294 #endif
295 #define lstat mingw_lstat
297 #ifndef _stati64
298 # define _stati64(x,y) mingw_stat(x,y)
299 #elif defined (_USE_32BIT_TIME_T)
300 # define _stat32i64(x,y) mingw_stat(x,y)
301 #else
302 # define _stat64(x,y) mingw_stat(x,y)
303 #endif
305 int mingw_utime(const char *file_name, const struct utimbuf *times);
306 #define utime mingw_utime
308 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
309 const char *dir,
310 int fhin, int fhout, int fherr);
311 int mingw_execvp(const char *cmd, char *const *argv);
312 #define execvp mingw_execvp
313 int mingw_execv(const char *cmd, char *const *argv);
314 #define execv mingw_execv
316 static inline unsigned int git_ntohl(unsigned int x)
317 { return (unsigned int)ntohl(x); }
318 #define ntohl git_ntohl
320 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
321 #define signal mingw_signal
323 int mingw_raise(int sig);
324 #define raise mingw_raise
327 * ANSI emulation wrappers
330 void winansi_init(void);
331 HANDLE winansi_get_osfhandle(int fd);
334 * git specific compatibility
337 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
338 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
339 static inline char *mingw_find_last_dir_sep(const char *path)
341 char *ret = NULL;
342 for (; *path; ++path)
343 if (is_dir_sep(*path))
344 ret = (char *)path;
345 return ret;
347 #define find_last_dir_sep mingw_find_last_dir_sep
348 int mingw_offset_1st_component(const char *path);
349 #define offset_1st_component mingw_offset_1st_component
350 #define PATH_SEP ';'
351 #define PRIuMAX "I64u"
352 #define PRId64 "I64d"
354 void mingw_open_html(const char *path);
355 #define open_html mingw_open_html
358 * helpers
361 char **make_augmented_environ(const char *const *vars);
362 void free_environ(char **env);
365 * Converts UTF-8 encoded string to UTF-16LE.
367 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
368 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
369 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
370 * Unicode) are converted to hex-code.
372 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
373 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
375 * Maximum space requirement for the target buffer is two wide chars per UTF-8
376 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
378 * The maximum space is needed only if the entire input string consists of
379 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
381 * | | UTF-8 | UTF-16 |
382 * Code point | UTF-8 sequence | bytes | words | ratio
383 * --------------+-------------------+-------+--------+-------
384 * 000000-00007f | 0-7f | 1 | 1 | 1
385 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
386 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
387 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
388 * invalid | 80-9f | 1 | 2 (b) | 2
389 * invalid | a0-ff | 1 | 1 | 1
391 * (a) encoded as UTF-16 surrogate pair
392 * (b) encoded as two hex digits
394 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
395 * or even indefinite-byte sequences, the largest valid code point \u10ffff
396 * encodes as only 4 UTF-8 bytes.
398 * Parameters:
399 * wcs: wide char target buffer
400 * utf: string to convert
401 * wcslen: size of target buffer (in wchar_t's)
402 * utflen: size of string to convert, or -1 if 0-terminated
404 * Returns:
405 * length of converted string (_wcslen(wcs)), or -1 on failure
407 * Errors:
408 * EINVAL: one of the input parameters is invalid (e.g. NULL)
409 * ERANGE: the output buffer is too small
411 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
414 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
416 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
418 return xutftowcsn(wcs, utf, wcslen, -1);
422 * Simplified file system specific variant of xutftowcsn, assumes output
423 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
424 * fails with ENAMETOOLONG if input string is too long.
426 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
428 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
429 if (result < 0 && errno == ERANGE)
430 errno = ENAMETOOLONG;
431 return result;
435 * Converts UTF-16LE encoded string to UTF-8.
437 * Maximum space requirement for the target buffer is three UTF-8 chars per
438 * wide char ((_wcslen(wcs) * 3) + 1).
440 * The maximum space is needed only if the entire input string consists of
441 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
442 * modulo surrogate pairs), as per the following table:
444 * | | UTF-16 | UTF-8 |
445 * Code point | UTF-16 sequence | words | bytes | ratio
446 * --------------+-----------------------+--------+-------+-------
447 * 000000-00007f | 0000-007f | 1 | 1 | 1
448 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
449 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
450 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
452 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
454 * Parameters:
455 * utf: target buffer
456 * wcs: wide string to convert
457 * utflen: size of target buffer
459 * Returns:
460 * length of converted string, or -1 on failure
462 * Errors:
463 * EINVAL: one of the input parameters is invalid (e.g. NULL)
464 * ERANGE: the output buffer is too small
466 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
469 * A critical section used in the implementation of the spawn
470 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
471 * the replacement main() macro below.
473 extern CRITICAL_SECTION pinfo_cs;
476 * A replacement of main() that adds win32 specific initialization.
479 void mingw_startup();
480 #define main(c,v) dummy_decl_mingw_main(); \
481 static int mingw_main(c,v); \
482 int main(int argc, char **argv) \
484 mingw_startup(); \
485 return mingw_main(__argc, (void *)__argv); \
487 static int mingw_main(c,v)
490 * Used by Pthread API implementation for Windows
492 extern int err_win_to_posix(DWORD winerr);