1 //===- WindowsSupport.h - Common Windows Include File -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines things specific to Windows implementations. In addition to
11 // providing some helpers for working with win32 APIs, this header wraps
12 // <windows.h> with some portability macros. Always include WindowsSupport.h
13 // instead of including <windows.h> directly.
15 //===----------------------------------------------------------------------===//
17 //===----------------------------------------------------------------------===//
18 //=== WARNING: Implementation here must contain only generic Win32 code that
19 //=== is guaranteed to work on *all* Win32 variants.
20 //===----------------------------------------------------------------------===//
22 #ifndef LLVM_SUPPORT_WINDOWSSUPPORT_H
23 #define LLVM_SUPPORT_WINDOWSSUPPORT_H
25 // mingw-w64 tends to define it as 0x0502 in its headers.
29 // Require at least Windows 7 API.
30 #define _WIN32_WINNT 0x0601
31 #define _WIN32_IE 0x0800 // MinGW at it again. FIXME: verify if still needed.
32 #define WIN32_LEAN_AND_MEAN
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/StringExtras.h"
39 #include "llvm/ADT/StringRef.h"
40 #include "llvm/ADT/Twine.h"
41 #include "llvm/Config/config.h" // Get build system configuration settings
42 #include "llvm/Support/Compiler.h"
43 #include <system_error>
50 #if !defined(__CYGWIN__) && !defined(__MINGW32__)
51 #include <VersionHelpers.h>
53 // Cygwin does not have the IsWindows8OrGreater() API.
54 // Some version of mingw does not have the API either.
55 inline bool IsWindows8OrGreater() {
56 OSVERSIONINFO osvi = {};
57 osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
58 if (!::GetVersionEx(&osvi))
60 return (osvi.dwMajorVersion > 6 ||
61 (osvi.dwMajorVersion == 6 && osvi.dwMinorVersion >= 2));
65 inline bool MakeErrMsg(std::string* ErrMsg, const std::string& prefix) {
69 DWORD LastError = GetLastError();
70 DWORD R = FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER |
71 FORMAT_MESSAGE_FROM_SYSTEM |
72 FORMAT_MESSAGE_MAX_WIDTH_MASK,
73 NULL, LastError, 0, (LPSTR)&buffer, 1, NULL);
75 *ErrMsg = prefix + ": " + buffer;
77 *ErrMsg = prefix + ": Unknown error";
78 *ErrMsg += " (0x" + llvm::utohexstr(LastError) + ")";
84 template <typename HandleTraits>
86 typedef typename HandleTraits::handle_type handle_type;
89 ScopedHandle(const ScopedHandle &other); // = delete;
90 void operator=(const ScopedHandle &other); // = delete;
93 : Handle(HandleTraits::GetInvalid()) {}
95 explicit ScopedHandle(handle_type h)
99 if (HandleTraits::IsValid(Handle))
100 HandleTraits::Close(Handle);
104 handle_type t = Handle;
105 Handle = HandleTraits::GetInvalid();
109 ScopedHandle &operator=(handle_type h) {
110 if (HandleTraits::IsValid(Handle))
111 HandleTraits::Close(Handle);
116 // True if Handle is valid.
117 explicit operator bool() const {
118 return HandleTraits::IsValid(Handle) ? true : false;
121 operator handle_type() const {
126 struct CommonHandleTraits {
127 typedef HANDLE handle_type;
129 static handle_type GetInvalid() {
130 return INVALID_HANDLE_VALUE;
133 static void Close(handle_type h) {
137 static bool IsValid(handle_type h) {
138 return h != GetInvalid();
142 struct JobHandleTraits : CommonHandleTraits {
143 static handle_type GetInvalid() {
148 struct CryptContextTraits : CommonHandleTraits {
149 typedef HCRYPTPROV handle_type;
151 static handle_type GetInvalid() {
155 static void Close(handle_type h) {
156 ::CryptReleaseContext(h, 0);
159 static bool IsValid(handle_type h) {
160 return h != GetInvalid();
164 struct FindHandleTraits : CommonHandleTraits {
165 static void Close(handle_type h) {
170 struct FileHandleTraits : CommonHandleTraits {};
172 typedef ScopedHandle<CommonHandleTraits> ScopedCommonHandle;
173 typedef ScopedHandle<FileHandleTraits> ScopedFileHandle;
174 typedef ScopedHandle<CryptContextTraits> ScopedCryptContext;
175 typedef ScopedHandle<FindHandleTraits> ScopedFindHandle;
176 typedef ScopedHandle<JobHandleTraits> ScopedJobHandle;
180 class SmallVectorImpl;
183 typename SmallVectorImpl<T>::const_pointer
184 c_str(SmallVectorImpl<T> &str) {
192 std::error_code widenPath(const Twine &Path8,
193 SmallVectorImpl<wchar_t> &Path16);
194 } // end namespace path
197 std::error_code UTF8ToUTF16(StringRef utf8, SmallVectorImpl<wchar_t> &utf16);
198 std::error_code UTF16ToUTF8(const wchar_t *utf16, size_t utf16_len,
199 SmallVectorImpl<char> &utf8);
200 /// Convert from UTF16 to the current code page used in the system
201 std::error_code UTF16ToCurCP(const wchar_t *utf16, size_t utf16_len,
202 SmallVectorImpl<char> &utf8);
203 } // end namespace windows
204 } // end namespace sys
205 } // end namespace llvm.