jpayne@69: // Copyright (c) 2013-2018 Sandstorm Development Group, Inc. and contributors
jpayne@69: // Licensed under the MIT License:
jpayne@69: //
jpayne@69: // Permission is hereby granted, free of charge, to any person obtaining a copy
jpayne@69: // of this software and associated documentation files (the "Software"), to deal
jpayne@69: // in the Software without restriction, including without limitation the rights
jpayne@69: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
jpayne@69: // copies of the Software, and to permit persons to whom the Software is
jpayne@69: // furnished to do so, subject to the following conditions:
jpayne@69: //
jpayne@69: // The above copyright notice and this permission notice shall be included in
jpayne@69: // all copies or substantial portions of the Software.
jpayne@69: //
jpayne@69: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jpayne@69: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jpayne@69: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jpayne@69: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
jpayne@69: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jpayne@69: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
jpayne@69: // THE SOFTWARE.
jpayne@69: 
jpayne@69: // This file replaces poorly-named #defines from windows.h with properly-namespaced versions, so
jpayne@69: // that they no longer conflict with similarly-named identifiers in other namespaces.
jpayne@69: //
jpayne@69: // This file must be #included some time after windows.h has been #included but before any attempt
jpayne@69: // to use the names for other purposes. However, this can be difficult to determine in header
jpayne@69: // files. Typically KJ / Cap'n Proto headers avoid including windows.h at all, but may use
jpayne@69: // conflicting identifiers. In order to relieve application developers from the need to include
jpayne@69: // windows-sanity.h themselves, we would like these headers to conditionally apply the fixes if
jpayne@69: // and only if windows.h was already included. Therefore, this header checks if windows.h has been
jpayne@69: // included and only applies fixups if this is the case. Furthermore, this header is designed such
jpayne@69: // that it can be included multiple times, and the fixups will be applied the first time it is
jpayne@69: // included *after* windows.h.
jpayne@69: //
jpayne@69: // Now, as long as any headers which need to use conflicting identifier names be sure to #include
jpayne@69: // windows-sanity.h, we can be sure that no conflicts will occur regardless of in what order the
jpayne@69: // application chooses to include these headers vs. windows.h.
jpayne@69: 
jpayne@69: #if !_WIN32 && !__CYGWIN__
jpayne@69: 
jpayne@69: // Not on Windows. Tell the compiler never to try to include this again.
jpayne@69: #pragma once
jpayne@69: 
jpayne@69: #elif defined(_INC_WINDOWS)
jpayne@69: 
jpayne@69: // We're on Windows and windows.h has been included. We need to fixup the namespace. We only need
jpayne@69: // to do this once, but we can't do it until windows.h has been included. Since that has happened
jpayne@69: // now, we use `#pragma once` to tell the compiler never to include this file again.
jpayne@69: #pragma once
jpayne@69: 
jpayne@69: namespace kj_win32_workarounds {
jpayne@69:   // Namespace containing constant definitions intended to replace constants that are defined as
jpayne@69:   // macros in the Windows headers. Do not refer to this namespace directly, we'll import it into
jpayne@69:   // the global scope below.
jpayne@69: 
jpayne@69: #ifdef ERROR  // This could be absent if e.g. NOGDI was used.
jpayne@69:   const auto ERROR_ = ERROR;
jpayne@69: #undef ERROR
jpayne@69:   const auto ERROR = ERROR_;
jpayne@69: #endif
jpayne@69: 
jpayne@69:   typedef VOID VOID_;
jpayne@69: #undef VOID
jpayne@69:   typedef VOID_ VOID;
jpayne@69: }
jpayne@69: 
jpayne@69: // Pull our constant definitions into the global namespace -- but only if they don't already exist
jpayne@69: // in the global namespace.
jpayne@69: using namespace kj_win32_workarounds;
jpayne@69: 
jpayne@69: #endif