Merge branch 'mc/commit-doc-grammofix' into maint
[git.git] / compat / mingw.h
blob5e499cfb71a00ea81013c1ed21e9a5e9dc9e2544
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 #ifndef ELOOP
39 #define ELOOP EMLINK
40 #endif
41 #define SHUT_WR SD_SEND
43 #define SIGHUP 1
44 #define SIGQUIT 3
45 #define SIGKILL 9
46 #define SIGPIPE 13
47 #define SIGALRM 14
48 #define SIGCHLD 17
50 #define F_GETFD 1
51 #define F_SETFD 2
52 #define FD_CLOEXEC 0x1
54 #ifndef EAFNOSUPPORT
55 #define EAFNOSUPPORT WSAEAFNOSUPPORT
56 #endif
57 #ifndef ECONNABORTED
58 #define ECONNABORTED WSAECONNABORTED
59 #endif
61 struct passwd {
62 char *pw_name;
63 char *pw_gecos;
64 char *pw_dir;
67 typedef void (__cdecl *sig_handler_t)(int);
68 struct sigaction {
69 sig_handler_t sa_handler;
70 unsigned sa_flags;
72 #define SA_RESTART 0
74 struct itimerval {
75 struct timeval it_value, it_interval;
77 #define ITIMER_REAL 0
80 * sanitize preprocessor namespace polluted by Windows headers defining
81 * macros which collide with git local versions
83 #undef HELP_COMMAND /* from winuser.h */
86 * trivial stubs
89 static inline int readlink(const char *path, char *buf, size_t bufsiz)
90 { errno = ENOSYS; return -1; }
91 static inline int symlink(const char *oldpath, const char *newpath)
92 { errno = ENOSYS; return -1; }
93 static inline int fchmod(int fildes, mode_t mode)
94 { errno = ENOSYS; return -1; }
95 static inline pid_t fork(void)
96 { errno = ENOSYS; return -1; }
97 static inline unsigned int alarm(unsigned int seconds)
98 { return 0; }
99 static inline int fsync(int fd)
100 { return _commit(fd); }
101 static inline pid_t getppid(void)
102 { return 1; }
103 static inline void sync(void)
105 static inline uid_t getuid(void)
106 { return 1; }
107 static inline struct passwd *getpwnam(const char *name)
108 { return NULL; }
109 static inline int fcntl(int fd, int cmd, ...)
111 if (cmd == F_GETFD || cmd == F_SETFD)
112 return 0;
113 errno = EINVAL;
114 return -1;
116 /* bash cannot reliably detect negative return codes as failure */
117 #define exit(code) exit((code) & 0xff)
118 #define sigemptyset(x) (void)0
119 static inline int sigaddset(sigset_t *set, int signum)
120 { return 0; }
121 #define SIG_UNBLOCK 0
122 static inline int sigprocmask(int how, const sigset_t *set, sigset_t *oldset)
123 { return 0; }
126 * simple adaptors
129 int mingw_mkdir(const char *path, int mode);
130 #define mkdir mingw_mkdir
132 #define WNOHANG 1
133 pid_t waitpid(pid_t pid, int *status, int options);
135 #define kill mingw_kill
136 int mingw_kill(pid_t pid, int sig);
138 #ifndef NO_OPENSSL
139 #include <openssl/ssl.h>
140 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
142 return SSL_set_fd(ssl, _get_osfhandle(fd));
144 #define SSL_set_fd mingw_SSL_set_fd
146 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
148 return SSL_set_rfd(ssl, _get_osfhandle(fd));
150 #define SSL_set_rfd mingw_SSL_set_rfd
152 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
154 return SSL_set_wfd(ssl, _get_osfhandle(fd));
156 #define SSL_set_wfd mingw_SSL_set_wfd
157 #endif
160 * implementations of missing functions
163 int pipe(int filedes[2]);
164 unsigned int sleep (unsigned int seconds);
165 int mkstemp(char *template);
166 int gettimeofday(struct timeval *tv, void *tz);
167 struct tm *gmtime_r(const time_t *timep, struct tm *result);
168 struct tm *localtime_r(const time_t *timep, struct tm *result);
169 int getpagesize(void); /* defined in MinGW's libgcc.a */
170 struct passwd *getpwuid(uid_t uid);
171 int setitimer(int type, struct itimerval *in, struct itimerval *out);
172 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
173 int link(const char *oldpath, const char *newpath);
176 * replacements of existing functions
179 int mingw_unlink(const char *pathname);
180 #define unlink mingw_unlink
182 int mingw_rmdir(const char *path);
183 #define rmdir mingw_rmdir
185 int mingw_open (const char *filename, int oflags, ...);
186 #define open mingw_open
188 int mingw_fgetc(FILE *stream);
189 #define fgetc mingw_fgetc
191 FILE *mingw_fopen (const char *filename, const char *otype);
192 #define fopen mingw_fopen
194 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
195 #define freopen mingw_freopen
197 int mingw_fflush(FILE *stream);
198 #define fflush mingw_fflush
200 int mingw_access(const char *filename, int mode);
201 #undef access
202 #define access mingw_access
204 int mingw_chdir(const char *dirname);
205 #define chdir mingw_chdir
207 int mingw_chmod(const char *filename, int mode);
208 #define chmod mingw_chmod
210 char *mingw_mktemp(char *template);
211 #define mktemp mingw_mktemp
213 char *mingw_getcwd(char *pointer, int len);
214 #define getcwd mingw_getcwd
216 char *mingw_getenv(const char *name);
217 #define getenv mingw_getenv
218 int mingw_putenv(const char *namevalue);
219 #define putenv mingw_putenv
220 #define unsetenv mingw_putenv
222 int mingw_gethostname(char *host, int namelen);
223 #define gethostname mingw_gethostname
225 struct hostent *mingw_gethostbyname(const char *host);
226 #define gethostbyname mingw_gethostbyname
228 void mingw_freeaddrinfo(struct addrinfo *res);
229 #define freeaddrinfo mingw_freeaddrinfo
231 int mingw_getaddrinfo(const char *node, const char *service,
232 const struct addrinfo *hints, struct addrinfo **res);
233 #define getaddrinfo mingw_getaddrinfo
235 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
236 char *host, DWORD hostlen, char *serv, DWORD servlen,
237 int flags);
238 #define getnameinfo mingw_getnameinfo
240 int mingw_socket(int domain, int type, int protocol);
241 #define socket mingw_socket
243 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
244 #define connect mingw_connect
246 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
247 #define bind mingw_bind
249 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
250 #define setsockopt mingw_setsockopt
252 int mingw_shutdown(int sockfd, int how);
253 #define shutdown mingw_shutdown
255 int mingw_listen(int sockfd, int backlog);
256 #define listen mingw_listen
258 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
259 #define accept mingw_accept
261 int mingw_rename(const char*, const char*);
262 #define rename mingw_rename
264 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
265 int mingw_getpagesize(void);
266 #define getpagesize mingw_getpagesize
267 #endif
269 struct rlimit {
270 unsigned int rlim_cur;
272 #define RLIMIT_NOFILE 0
274 static inline int getrlimit(int resource, struct rlimit *rlp)
276 if (resource != RLIMIT_NOFILE) {
277 errno = EINVAL;
278 return -1;
281 rlp->rlim_cur = 2048;
282 return 0;
286 * Use mingw specific stat()/lstat()/fstat() implementations on Windows.
288 #define off_t off64_t
289 #define lseek _lseeki64
291 /* use struct stat with 64 bit st_size */
292 #ifdef stat
293 #undef stat
294 #endif
295 #define stat _stati64
296 int mingw_lstat(const char *file_name, struct stat *buf);
297 int mingw_stat(const char *file_name, struct stat *buf);
298 int mingw_fstat(int fd, struct stat *buf);
299 #ifdef fstat
300 #undef fstat
301 #endif
302 #define fstat mingw_fstat
303 #ifdef lstat
304 #undef lstat
305 #endif
306 #define lstat mingw_lstat
308 #ifndef _stati64
309 # define _stati64(x,y) mingw_stat(x,y)
310 #elif defined (_USE_32BIT_TIME_T)
311 # define _stat32i64(x,y) mingw_stat(x,y)
312 #else
313 # define _stat64(x,y) mingw_stat(x,y)
314 #endif
316 int mingw_utime(const char *file_name, const struct utimbuf *times);
317 #define utime mingw_utime
319 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
320 const char *dir,
321 int fhin, int fhout, int fherr);
322 int mingw_execvp(const char *cmd, char *const *argv);
323 #define execvp mingw_execvp
324 int mingw_execv(const char *cmd, char *const *argv);
325 #define execv mingw_execv
327 static inline unsigned int git_ntohl(unsigned int x)
328 { return (unsigned int)ntohl(x); }
329 #define ntohl git_ntohl
331 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
332 #define signal mingw_signal
334 int mingw_raise(int sig);
335 #define raise mingw_raise
338 * ANSI emulation wrappers
341 void winansi_init(void);
342 HANDLE winansi_get_osfhandle(int fd);
345 * git specific compatibility
348 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
349 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
350 static inline char *mingw_find_last_dir_sep(const char *path)
352 char *ret = NULL;
353 for (; *path; ++path)
354 if (is_dir_sep(*path))
355 ret = (char *)path;
356 return ret;
358 #define find_last_dir_sep mingw_find_last_dir_sep
359 int mingw_offset_1st_component(const char *path);
360 #define offset_1st_component mingw_offset_1st_component
361 #define PATH_SEP ';'
362 #define PRIuMAX "I64u"
363 #define PRId64 "I64d"
365 void mingw_open_html(const char *path);
366 #define open_html mingw_open_html
368 void mingw_mark_as_git_dir(const char *dir);
369 #define mark_as_git_dir mingw_mark_as_git_dir
372 * Converts UTF-8 encoded string to UTF-16LE.
374 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
375 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
376 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
377 * Unicode) are converted to hex-code.
379 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
380 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
382 * Maximum space requirement for the target buffer is two wide chars per UTF-8
383 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
385 * The maximum space is needed only if the entire input string consists of
386 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
388 * | | UTF-8 | UTF-16 |
389 * Code point | UTF-8 sequence | bytes | words | ratio
390 * --------------+-------------------+-------+--------+-------
391 * 000000-00007f | 0-7f | 1 | 1 | 1
392 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
393 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
394 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
395 * invalid | 80-9f | 1 | 2 (b) | 2
396 * invalid | a0-ff | 1 | 1 | 1
398 * (a) encoded as UTF-16 surrogate pair
399 * (b) encoded as two hex digits
401 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
402 * or even indefinite-byte sequences, the largest valid code point \u10ffff
403 * encodes as only 4 UTF-8 bytes.
405 * Parameters:
406 * wcs: wide char target buffer
407 * utf: string to convert
408 * wcslen: size of target buffer (in wchar_t's)
409 * utflen: size of string to convert, or -1 if 0-terminated
411 * Returns:
412 * length of converted string (_wcslen(wcs)), or -1 on failure
414 * Errors:
415 * EINVAL: one of the input parameters is invalid (e.g. NULL)
416 * ERANGE: the output buffer is too small
418 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
421 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
423 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
425 return xutftowcsn(wcs, utf, wcslen, -1);
429 * Simplified file system specific variant of xutftowcsn, assumes output
430 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
431 * fails with ENAMETOOLONG if input string is too long.
433 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
435 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
436 if (result < 0 && errno == ERANGE)
437 errno = ENAMETOOLONG;
438 return result;
442 * Converts UTF-16LE encoded string to UTF-8.
444 * Maximum space requirement for the target buffer is three UTF-8 chars per
445 * wide char ((_wcslen(wcs) * 3) + 1).
447 * The maximum space is needed only if the entire input string consists of
448 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
449 * modulo surrogate pairs), as per the following table:
451 * | | UTF-16 | UTF-8 |
452 * Code point | UTF-16 sequence | words | bytes | ratio
453 * --------------+-----------------------+--------+-------+-------
454 * 000000-00007f | 0000-007f | 1 | 1 | 1
455 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
456 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
457 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
459 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
461 * Parameters:
462 * utf: target buffer
463 * wcs: wide string to convert
464 * utflen: size of target buffer
466 * Returns:
467 * length of converted string, or -1 on failure
469 * Errors:
470 * EINVAL: one of the input parameters is invalid (e.g. NULL)
471 * ERANGE: the output buffer is too small
473 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
476 * A critical section used in the implementation of the spawn
477 * functions (mingw_spawnv[p]e()) and waitpid(). Intialised in
478 * the replacement main() macro below.
480 extern CRITICAL_SECTION pinfo_cs;
483 * A replacement of main() that adds win32 specific initialization.
486 void mingw_startup();
487 #define main(c,v) dummy_decl_mingw_main(); \
488 static int mingw_main(c,v); \
489 int main(int argc, char **argv) \
491 mingw_startup(); \
492 return mingw_main(__argc, (void *)__argv); \
494 static int mingw_main(c,v)
497 * Used by Pthread API implementation for Windows
499 extern int err_win_to_posix(DWORD winerr);