Win32: add Unicode conversion functions
[git/dscho.git] / compat / mingw.h
blob661455efb2c0e373d95de573a9ba8177ebef151b
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 #define EWOULDBLOCK EAGAIN
36 #define SHUT_WR SD_SEND
38 #define SIGHUP 1
39 #define SIGQUIT 3
40 #define SIGKILL 9
41 #define SIGPIPE 13
42 #define SIGALRM 14
43 #define SIGCHLD 17
45 #define F_GETFD 1
46 #define F_SETFD 2
47 #define FD_CLOEXEC 0x1
49 #define EAFNOSUPPORT WSAEAFNOSUPPORT
50 #define ECONNABORTED WSAECONNABORTED
52 struct passwd {
53 char *pw_name;
54 char *pw_gecos;
55 char *pw_dir;
58 extern char *getpass(const char *prompt);
60 typedef void (__cdecl *sig_handler_t)(int);
61 struct sigaction {
62 sig_handler_t sa_handler;
63 unsigned sa_flags;
65 #define sigemptyset(x) (void)0
66 #define SA_RESTART 0
68 struct itimerval {
69 struct timeval it_value, it_interval;
71 #define ITIMER_REAL 0
74 * sanitize preprocessor namespace polluted by Windows headers defining
75 * macros which collide with git local versions
77 #undef HELP_COMMAND /* from winuser.h */
80 * trivial stubs
83 static inline int readlink(const char *path, char *buf, size_t bufsiz)
84 { errno = ENOSYS; return -1; }
85 static inline int symlink(const char *oldpath, const char *newpath)
86 { errno = ENOSYS; return -1; }
87 static inline int fchmod(int fildes, mode_t mode)
88 { errno = ENOSYS; return -1; }
89 static inline pid_t fork(void)
90 { errno = ENOSYS; return -1; }
91 static inline unsigned int alarm(unsigned int seconds)
92 { return 0; }
93 static inline int fsync(int fd)
94 { return _commit(fd); }
95 static inline pid_t getppid(void)
96 { return 1; }
97 static inline void sync(void)
99 static inline uid_t getuid(void)
100 { return 1; }
101 static inline struct passwd *getpwnam(const char *name)
102 { return NULL; }
103 static inline int fcntl(int fd, int cmd, ...)
105 if (cmd == F_GETFD || cmd == F_SETFD)
106 return 0;
107 errno = EINVAL;
108 return -1;
110 /* bash cannot reliably detect negative return codes as failure */
111 #define exit(code) exit((code) & 0xff)
114 * simple adaptors
117 int mingw_mkdir(const char *path, int mode);
118 #define mkdir mingw_mkdir
120 #define WNOHANG 1
121 pid_t waitpid(pid_t pid, int *status, int options);
123 #define kill mingw_kill
124 int mingw_kill(pid_t pid, int sig);
126 #ifndef NO_OPENSSL
127 #include <openssl/ssl.h>
128 static inline int mingw_SSL_set_fd(SSL *ssl, int fd)
130 return SSL_set_fd(ssl, _get_osfhandle(fd));
132 #define SSL_set_fd mingw_SSL_set_fd
134 static inline int mingw_SSL_set_rfd(SSL *ssl, int fd)
136 return SSL_set_rfd(ssl, _get_osfhandle(fd));
138 #define SSL_set_rfd mingw_SSL_set_rfd
140 static inline int mingw_SSL_set_wfd(SSL *ssl, int fd)
142 return SSL_set_wfd(ssl, _get_osfhandle(fd));
144 #define SSL_set_wfd mingw_SSL_set_wfd
145 #endif
148 * implementations of missing functions
151 int pipe(int filedes[2]);
152 unsigned int sleep (unsigned int seconds);
153 int mkstemp(char *template);
154 int gettimeofday(struct timeval *tv, void *tz);
155 struct tm *gmtime_r(const time_t *timep, struct tm *result);
156 struct tm *localtime_r(const time_t *timep, struct tm *result);
157 int getpagesize(void); /* defined in MinGW's libgcc.a */
158 struct passwd *getpwuid(uid_t uid);
159 int setitimer(int type, struct itimerval *in, struct itimerval *out);
160 int sigaction(int sig, struct sigaction *in, struct sigaction *out);
161 int link(const char *oldpath, const char *newpath);
164 * replacements of existing functions
167 int mingw_unlink(const char *pathname);
168 #define unlink mingw_unlink
170 int mingw_rmdir(const char *path);
171 #define rmdir mingw_rmdir
173 int mingw_open (const char *filename, int oflags, ...);
174 #define open mingw_open
176 ssize_t mingw_write(int fd, const void *buf, size_t count);
177 #define write mingw_write
179 FILE *mingw_fopen (const char *filename, const char *otype);
180 #define fopen mingw_fopen
182 FILE *mingw_freopen (const char *filename, const char *otype, FILE *stream);
183 #define freopen mingw_freopen
185 char *mingw_getcwd(char *pointer, int len);
186 #define getcwd mingw_getcwd
188 char *mingw_getenv(const char *name);
189 #define getenv mingw_getenv
191 int mingw_gethostname(char *host, int namelen);
192 #define gethostname mingw_gethostname
194 struct hostent *mingw_gethostbyname(const char *host);
195 #define gethostbyname mingw_gethostbyname
197 void mingw_freeaddrinfo(struct addrinfo *res);
198 #define freeaddrinfo mingw_freeaddrinfo
200 int mingw_getaddrinfo(const char *node, const char *service,
201 const struct addrinfo *hints, struct addrinfo **res);
202 #define getaddrinfo mingw_getaddrinfo
204 int mingw_getnameinfo(const struct sockaddr *sa, socklen_t salen,
205 char *host, DWORD hostlen, char *serv, DWORD servlen,
206 int flags);
207 #define getnameinfo mingw_getnameinfo
209 int mingw_socket(int domain, int type, int protocol);
210 #define socket mingw_socket
212 int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz);
213 #define connect mingw_connect
215 int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz);
216 #define bind mingw_bind
218 int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen);
219 #define setsockopt mingw_setsockopt
221 int mingw_shutdown(int sockfd, int how);
222 #define shutdown mingw_shutdown
224 int mingw_listen(int sockfd, int backlog);
225 #define listen mingw_listen
227 int mingw_accept(int sockfd, struct sockaddr *sa, socklen_t *sz);
228 #define accept mingw_accept
230 int mingw_rename(const char*, const char*);
231 #define rename mingw_rename
233 #if defined(USE_WIN32_MMAP) || defined(_MSC_VER)
234 int mingw_getpagesize(void);
235 #define getpagesize mingw_getpagesize
236 #endif
238 struct rlimit {
239 unsigned int rlim_cur;
241 #define RLIMIT_NOFILE 0
243 static inline int getrlimit(int resource, struct rlimit *rlp)
245 if (resource != RLIMIT_NOFILE) {
246 errno = EINVAL;
247 return -1;
250 rlp->rlim_cur = 2048;
251 return 0;
254 /* Use mingw_lstat() instead of lstat()/stat() and
255 * mingw_fstat() instead of fstat() on Windows.
257 #define off_t off64_t
258 #define lseek _lseeki64
259 #ifndef ALREADY_DECLARED_STAT_FUNCS
260 #define stat _stati64
261 int mingw_lstat(const char *file_name, struct stat *buf);
262 int mingw_stat(const char *file_name, struct stat *buf);
263 int mingw_fstat(int fd, struct stat *buf);
264 #define fstat mingw_fstat
265 #define lstat mingw_lstat
266 #define _stati64(x,y) mingw_stat(x,y)
267 #endif
269 int mingw_utime(const char *file_name, const struct utimbuf *times);
270 #define utime mingw_utime
272 pid_t mingw_spawnvpe(const char *cmd, const char **argv, char **env,
273 const char *dir,
274 int fhin, int fhout, int fherr);
275 int mingw_execvp(const char *cmd, char *const *argv);
276 #define execvp mingw_execvp
277 int mingw_execv(const char *cmd, char *const *argv);
278 #define execv mingw_execv
280 static inline unsigned int git_ntohl(unsigned int x)
281 { return (unsigned int)ntohl(x); }
282 #define ntohl git_ntohl
284 sig_handler_t mingw_signal(int sig, sig_handler_t handler);
285 #define signal mingw_signal
288 * ANSI emulation wrappers
291 void winansi_init(void);
292 int winansi_isatty(int fd);
293 HANDLE winansi_get_osfhandle(int fd);
294 #define isatty winansi_isatty
297 * git specific compatibility
300 #define has_dos_drive_prefix(path) (isalpha(*(path)) && (path)[1] == ':')
301 #define is_dir_sep(c) ((c) == '/' || (c) == '\\')
302 static inline char *mingw_find_last_dir_sep(const char *path)
304 char *ret = NULL;
305 for (; *path; ++path)
306 if (is_dir_sep(*path))
307 ret = (char *)path;
308 return ret;
310 #define find_last_dir_sep mingw_find_last_dir_sep
311 int mingw_offset_1st_component(const char *path);
312 #define offset_1st_component mingw_offset_1st_component
313 #define PATH_SEP ';'
314 #define PRIuMAX "I64u"
316 void mingw_open_html(const char *path);
317 #define open_html mingw_open_html
319 void mingw_mark_as_git_dir(const char *dir);
320 #define mark_as_git_dir mingw_mark_as_git_dir
323 * helpers
326 char **make_augmented_environ(const char *const *vars);
327 void free_environ(char **env);
330 * Converts UTF-8 encoded string to UTF-16LE.
332 * To support repositories with legacy-encoded file names, invalid UTF-8 bytes
333 * 0xa0 - 0xff are converted to corresponding printable Unicode chars \u00a0 -
334 * \u00ff, and invalid UTF-8 bytes 0x80 - 0x9f (which would make non-printable
335 * Unicode) are converted to hex-code.
337 * Lead-bytes not followed by an appropriate number of trail-bytes, over-long
338 * encodings and 4-byte encodings > \u10ffff are detected as invalid UTF-8.
340 * Maximum space requirement for the target buffer is two wide chars per UTF-8
341 * char (((strlen(utf) * 2) + 1) [* sizeof(wchar_t)]).
343 * The maximum space is needed only if the entire input string consists of
344 * invalid UTF-8 bytes in range 0x80-0x9f, as per the following table:
346 * | | UTF-8 | UTF-16 |
347 * Code point | UTF-8 sequence | bytes | words | ratio
348 * --------------+-------------------+-------+--------+-------
349 * 000000-00007f | 0-7f | 1 | 1 | 1
350 * 000080-0007ff | c2-df + 80-bf | 2 | 1 | 0.5
351 * 000800-00ffff | e0-ef + 2 * 80-bf | 3 | 1 | 0.33
352 * 010000-10ffff | f0-f4 + 3 * 80-bf | 4 | 2 (a) | 0.5
353 * invalid | 80-9f | 1 | 2 (b) | 2
354 * invalid | a0-ff | 1 | 1 | 1
356 * (a) encoded as UTF-16 surrogate pair
357 * (b) encoded as two hex digits
359 * Note that, while the UTF-8 encoding scheme can be extended to 5-byte, 6-byte
360 * or even indefinite-byte sequences, the largest valid code point \u10ffff
361 * encodes as only 4 UTF-8 bytes.
363 * Parameters:
364 * wcs: wide char target buffer
365 * utf: string to convert
366 * wcslen: size of target buffer (in wchar_t's)
367 * utflen: size of string to convert, or -1 if 0-terminated
369 * Returns:
370 * length of converted string (_wcslen(wcs)), or -1 on failure
372 * Errors:
373 * EINVAL: one of the input parameters is invalid (e.g. NULL)
374 * ERANGE: the output buffer is too small
376 int xutftowcsn(wchar_t *wcs, const char *utf, size_t wcslen, int utflen);
379 * Simplified variant of xutftowcsn, assumes input string is \0-terminated.
381 static inline int xutftowcs(wchar_t *wcs, const char *utf, size_t wcslen)
383 return xutftowcsn(wcs, utf, wcslen, -1);
387 * Simplified file system specific variant of xutftowcsn, assumes output
388 * buffer size is MAX_PATH wide chars and input string is \0-terminated,
389 * fails with ENAMETOOLONG if input string is too long.
391 static inline int xutftowcs_path(wchar_t *wcs, const char *utf)
393 int result = xutftowcsn(wcs, utf, MAX_PATH, -1);
394 if (result < 0 && errno == ERANGE)
395 errno = ENAMETOOLONG;
396 return result;
400 * Converts UTF-16LE encoded string to UTF-8.
402 * Maximum space requirement for the target buffer is three UTF-8 chars per
403 * wide char ((_wcslen(wcs) * 3) + 1).
405 * The maximum space is needed only if the entire input string consists of
406 * UTF-16 words in range 0x0800-0xd7ff or 0xe000-0xffff (i.e. \u0800-\uffff
407 * modulo surrogate pairs), as per the following table:
409 * | | UTF-16 | UTF-8 |
410 * Code point | UTF-16 sequence | words | bytes | ratio
411 * --------------+-----------------------+--------+-------+-------
412 * 000000-00007f | 0000-007f | 1 | 1 | 1
413 * 000080-0007ff | 0080-07ff | 1 | 2 | 2
414 * 000800-00ffff | 0800-d7ff / e000-ffff | 1 | 3 | 3
415 * 010000-10ffff | d800-dbff + dc00-dfff | 2 | 4 | 2
417 * Note that invalid code points > 10ffff cannot be represented in UTF-16.
419 * Parameters:
420 * utf: target buffer
421 * wcs: wide string to convert
422 * utflen: size of target buffer
424 * Returns:
425 * length of converted string, or -1 on failure
427 * Errors:
428 * EINVAL: one of the input parameters is invalid (e.g. NULL)
429 * ERANGE: the output buffer is too small
431 int xwcstoutf(char *utf, const wchar_t *wcs, size_t utflen);
434 * A replacement of main() that adds win32 specific initialization.
437 void mingw_startup();
438 #define main(c,v) dummy_decl_mingw_main(); \
439 static int mingw_main(); \
440 int main(int argc, const char **argv) \
442 mingw_startup(); \
443 return mingw_main(__argc, __argv); \
445 static int mingw_main(c,v)
448 * Used by Pthread API implementation for Windows
450 extern int err_win_to_posix(DWORD winerr);
452 extern const char *get_windows_home_directory();
453 #define get_home_directory() get_windows_home_directory()