src/windows/port.h

   1 /* Copyright (c) 2008, Google Inc.
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * ---
  31  * Author: Craig Silverstein
  32  * Copied from google-perftools and modified by Shinichiro Hamaji
  33  *
  34  * These are some portability typedefs and defines to make it a bit
  35  * easier to compile this code under VC++.
  36  *
  37  * Several of these are taken from glib:
  38  *    http://developer.gnome.org/doc/API/glib/glib-windows-compatability-functions.html
  39  */
  40
  41 #ifndef CTEMPLATE_WINDOWS_PORT_H_
  42 #define CTEMPLATE_WINDOWS_PORT_H_
  43
  44 #include "config.h"
  45
  46 #ifdef _WIN32
  47
  48 #ifndef WIN32_LEAN_AND_MEAN
  49 #define WIN32_LEAN_AND_MEAN  /* We always want minimal includes */
  50 #endif
  51
  52 #include <windows.h>
  53 #include <winsock.h>         /* for gethostname */
  54 #include <io.h>              /* because we so often use open/close/etc */
  55 #include <direct.h>          /* for _getcwd() */
  56 #include <process.h>         /* for _getpid() */
  57 #include <stdio.h>           /* read in vsnprintf decl. before redifining it */
  58 #include <stdarg.h>          /* template_dictionary.cc uses va_copy */
  59 #include <string.h>          /* for _strnicmp(), strerror_s() */
  60 #include <time.h>            /* for localtime_s() */
  61 /* Note: the C++ #includes are all together at the bottom.  This file is
  62  * used by both C and C++ code, so we put all the C++ together.
  63  */
  64
  65 /* 4244: otherwise we get problems when substracting two size_t's to an int
  66  * 4251: it's complaining about a private struct I've chosen not to dllexport
  67  * 4355: we use this in a constructor, but we do it safely
  68  * 4715: for some reason VC++ stopped realizing you can't return after abort()
  69  * 4800: we know we're casting ints/char*'s to bools, and we're ok with that
  70  * 4996: Yes, we're ok using "unsafe" functions like fopen() and strerror()
  71  */
  72 #pragma warning(disable:4244 4251 4355 4715 4800 4996)
  73
  74 /* file I/O */
  75 #define PATH_MAX 1024
  76 #define access  _access
  77 #define getcwd  _getcwd
  78 #define open    _open
  79 #define read    _read
  80 #define write   _write
  81 #define lseek   _lseek
  82 #define close   _close
  83 #define popen   _popen
  84 #define pclose  _pclose
  85 #define R_OK    04           /* read-only (for access()) */
  86 #define S_ISDIR(m)  (((m) & _S_IFMT) == _S_IFDIR)
  87 #ifndef __MINGW32__
  88 enum { STDIN_FILENO = 0, STDOUT_FILENO = 1, STDERR_FILENO = 2 };
  89 #endif
  90 #define S_IRUSR S_IREAD
  91 #define S_IWUSR S_IWRITE
  92
  93 /* Not quite as lightweight as a hard-link, but more than good enough for us. */
  94 #define link(oldpath, newpath)  CopyFileA(oldpath, newpath, false)
  95
  96 #define strcasecmp   _stricmp
  97 #define strncasecmp  _strnicmp
  98
  99 /* In windows-land, hash<> is called hash_compare<> (from xhash.h) */
 100 /* VC11 provides std::hash */
 101 #if defined(_MSC_VER) && (_MSC_VER < 1700)
 102 #define hash  hash_compare
 103 #endif
 104
 105 /* Sleep is in ms, on windows */
 106 #define sleep(secs)  Sleep((secs) * 1000)
 107
 108 /* We can't just use _vsnprintf and _snprintf as drop-in-replacements,
 109  * because they don't always NUL-terminate. :-(  We also can't use the
 110  * name vsnprintf, since windows defines that (but not snprintf (!)).
 111  */
 112 extern int snprintf(char *str, size_t size,
 113                                        const char *format, ...);
 114 extern int safe_vsnprintf(char *str, size_t size,
 115                           const char *format, va_list ap);
 116 #define vsnprintf(str, size, format, ap)  safe_vsnprintf(str, size, format, ap)
 117 #define va_copy(dst, src)  (dst) = (src)
 118
 119 /* Windows doesn't support specifying the number of buckets as a
 120  * hash_map constructor arg, so we leave this blank.
 121  */
 122 #define CTEMPLATE_SMALL_HASHTABLE
 123
 124 #define DEFAULT_TEMPLATE_ROOTDIR  ".."
 125
 126 // ----------------------------------- SYSTEM/PROCESS
 127 typedef int pid_t;
 128 #define getpid  _getpid
 129
 130 // ----------------------------------- THREADS
 131 typedef DWORD pthread_t;
 132 typedef DWORD pthread_key_t;
 133 typedef LONG pthread_once_t;
 134 enum { PTHREAD_ONCE_INIT = 0 };   // important that this be 0! for SpinLock
 135 #define pthread_self  GetCurrentThreadId
 136 #define pthread_equal(pthread_t_1, pthread_t_2)  ((pthread_t_1)==(pthread_t_2))
 137
 138 inline struct tm* localtime_r(const time_t* timep, struct tm* result) {
 139   localtime_s(result, timep);
 140   return result;
 141 }
 142
 143 inline char* strerror_r(int errnum, char* buf, size_t buflen) {
 144   strerror_s(buf, buflen, errnum);
 145   return buf;
 146 }
 147
 148 #ifndef __cplusplus
 149 /* I don't see how to get inlining for C code in MSVC.  Ah well. */
 150 #define inline
 151 #endif
 152
 153 #endif  /* _WIN32 */
 154
 155 #endif  /* CTEMPLATE_WINDOWS_PORT_H_ */