blob: 9ee9d1fc8e69db453c2288f9b29334deafee9373 [file] [log] [blame]
Reid Spencer0b22ba42004-09-15 05:48:11 +00001//===- Win32/Win32.h - Common Win32 Include File ----------------*- C++ -*-===//
Misha Brukmanf976c852005-04-21 22:55:34 +00002//
Reid Spencer0b22ba42004-09-15 05:48:11 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanf976c852005-04-21 22:55:34 +00007//
Reid Spencer0b22ba42004-09-15 05:48:11 +00008//===----------------------------------------------------------------------===//
9//
Jeff Cohen6d235222005-07-13 02:15:18 +000010// This file defines things specific to Win32 implementations.
Reid Spencer0b22ba42004-09-15 05:48:11 +000011//
12//===----------------------------------------------------------------------===//
13
14//===----------------------------------------------------------------------===//
Jeff Cohen6d235222005-07-13 02:15:18 +000015//=== WARNING: Implementation here must contain only generic Win32 code that
16//=== is guaranteed to work on *all* Win32 variants.
Reid Spencer0b22ba42004-09-15 05:48:11 +000017//===----------------------------------------------------------------------===//
18
Jeff Cohen6d235222005-07-13 02:15:18 +000019// Require at least Windows 2000 API.
20#define _WIN32_WINNT 0x0500
Michael J. Spencereebe9702010-11-09 15:11:19 +000021#define _WIN32_IE 0x0500 // MinGW at it again.
Michael J. Spencer966023b2010-11-09 15:11:07 +000022#define WIN32_LEAN_AND_MEAN
Jeff Cohen6d235222005-07-13 02:15:18 +000023
Michael J. Spencer64cf7522010-11-09 15:10:29 +000024#include "llvm/Config/config.h" // Get build system configuration settings
Michael J. Spencer6d990922010-11-09 15:10:56 +000025#include <Windows.h>
Michael J. Spencereebe9702010-11-09 15:11:19 +000026#include <ShlObj.h>
Reid Spencer0b22ba42004-09-15 05:48:11 +000027#include <cassert>
28#include <string>
29
Reid Spencer5a060772006-08-23 07:30:48 +000030inline bool MakeErrMsg(std::string* ErrMsg, const std::string& prefix) {
Reid Spencer4ce5dc62006-08-21 06:02:44 +000031 if (!ErrMsg)
Reid Spencer5a060772006-08-23 07:30:48 +000032 return true;
Reid Spencer4ce5dc62006-08-21 06:02:44 +000033 char *buffer = NULL;
34 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
35 NULL, GetLastError(), 0, (LPSTR)&buffer, 1, NULL);
Anton Korobeynikov7d515442006-09-01 20:35:17 +000036 *ErrMsg = prefix + buffer;
Reid Spencer4ce5dc62006-08-21 06:02:44 +000037 LocalFree(buffer);
Reid Spencer5a060772006-08-23 07:30:48 +000038 return true;
Reid Spencer4ce5dc62006-08-21 06:02:44 +000039}
Jeff Cohen0a182672007-03-05 05:22:08 +000040
41class AutoHandle {
42 HANDLE handle;
43
44public:
45 AutoHandle(HANDLE h) : handle(h) {}
46
47 ~AutoHandle() {
48 if (handle)
49 CloseHandle(handle);
50 }
51
52 operator HANDLE() {
53 return handle;
54 }
55
56 AutoHandle &operator=(HANDLE h) {
57 handle = h;
58 return *this;
59 }
60};
Michael J. Spencer7eec50b2010-12-06 04:28:13 +000061
62template <class HandleType, HandleType InvalidHandle,
63 class DeleterType, DeleterType D>
64class ScopedHandle {
65 HandleType Handle;
66
67public:
68 ScopedHandle() : Handle(InvalidHandle) {}
69 ScopedHandle(HandleType handle) : Handle(handle) {}
70
71 ~ScopedHandle() {
72 if (Handle != InvalidHandle)
73 D(Handle);
74 }
75
76 HandleType take() {
77 HandleType temp = Handle;
78 Handle = InvalidHandle;
79 return temp;
80 }
81
82 operator HandleType() const { return Handle; }
83
84 ScopedHandle &operator=(HandleType handle) {
85 Handle = handle;
86 return *this;
87 }
88
89 typedef void (*unspecified_bool_type)();
90 static void unspecified_bool_true() {}
91
92 // True if Handle is valid.
93 operator unspecified_bool_type() const {
94 return Handle == InvalidHandle ? 0 : unspecified_bool_true;
95 }
96
Michael J. Spencer753cbbb2010-12-06 04:28:42 +000097 bool operator!() const {
98 return Handle == InvalidHandle;
99 }
Michael J. Spencer7eec50b2010-12-06 04:28:13 +0000100};
Michael J. Spencer753cbbb2010-12-06 04:28:42 +0000101
102typedef ScopedHandle<HANDLE, INVALID_HANDLE_VALUE,
103 BOOL (WINAPI*)(HANDLE), ::FindClose>
104 ScopedFindHandle;