[PATCH v3 4/4] Add explicit Cygwin check to guard WIN32 header inclusion

Ramsay Jones· Nov 9, 2009, 19:31 UTC · lore

Since commit 435bdf8c ("Make usage of windows.h lean and mean", 16-9-2009), the amount of code potentially including the WIN32 API header files has greatly increased. In particular, the Cygwin build is at greater risk of inadvertently including WIN32 code within preprocessor sections protected by the WIN32 or _WIN32 macros.

The previous commit message, along with comments elsewhere, assert that the WIN32 macro is not defined on Cygwin. Currently, this is true for the cygwin build. However, the cygwin platform can be used to develop WIN32 GUI, WIN32 console, and POSIX applications. Indeed it is possible to create applications which use a mix of the WIN32 API and POSIX code (eg git!).

Unlike native WIN32 compilers, gcc on cygwin does not automatically define the _WIN32 macro. However, as soon as you include the <windows.h> header file, the _WIN32 and WIN32 macros are defined.

In order to reduce the risk of problems in the future, we protect the inclusion of the windows header with an explicit check for __CYGWIN__. Also, we move the other use of the <windows.h> header from compat/win32.h to compat/cygwin.c

Signed-off-by: Ramsay Jones <ramsay@ramsay1.demon.co.uk>
---

Changes since v2:
    - removed indentation from the #if-#endif block

I hope you don't mind, but I've only sent this patch, rather than re-send the whole series. If you would like a complete re-send, just let me know.

ATB, Ramsay Jones

 compat/cygwin.c   |    1 +
 compat/win32.h    |    3 ---
 git-compat-util.h |    2 +-
 3 files changed, 2 insertions(+), 4 deletions(-)

Show changes to 3 files +2 −4

compat/cygwin.c, compat/win32.h, git-compat-util.h

diff --git a/compat/cygwin.c b/compat/cygwin.c
index b4a51b9..6695515 100644
--- a/compat/cygwin.c
+++ b/compat/cygwin.c
@@ -1,5 +1,6 @@
 #define WIN32_LEAN_AND_MEAN
 #include "../git-compat-util.h"
+#include <windows.h>
 #include "win32.h"
 #include "../cache.h" /* to read configuration */
 
diff --git a/compat/win32.h b/compat/win32.h
index 8ce9104..a7ed72b 100644
--- a/compat/win32.h
+++ b/compat/win32.h
@@ -2,9 +2,6 @@
 #define WIN32_H
 
 /* common Win32 functions for MinGW and Cygwin */
-#ifndef WIN32         /* Not defined by Cygwin */
-#include <windows.h>
-#endif
 
 static inline int file_attr_to_st_mode (DWORD attr)
 {
diff --git a/git-compat-util.h b/git-compat-util.h
index ef60803..0cd2693 100644
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -65,7 +65,7 @@
 #define _NETBSD_SOURCE 1
 #define _SGI_SOURCE 1
 
-#ifdef WIN32 /* Both MinGW and MSVC */
+#if defined(_WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
 #define WIN32_LEAN_AND_MEAN  /* stops windows.h including winsock.h */
 #include <winsock2.h>
 #include <windows.h>

-- 
1.6.5

Junio C Hamano· Nov 9, 2009, 22:25 UTC · re: Ramsay Jones · lore

Re: [PATCH v3 4/4] Add explicit Cygwin check to guard WIN32 header inclusion

Ramsay Jones <ramsay@ramsay1.demon.co.uk> writes:

Show 6 quoted lines

> Changes since v2:
>     - removed indentation from the #if-#endif block
>
> I hope you don't mind, but I've only sent this patch, rather than
> re-send the whole series. If you would like a complete re-send, just
> let me know.

No, I don't mind "replace only this one out of the four-patch series" at all as long as what's being replaced is marked clearly enough (which you did in this case).

But I thought J6t had problems with what this particular patch does, not how the patch was indented? So I'd wait for more comments and hopefully an Ack from him before touching this one.

v3, 4 partsAdd explicit Cygwin check to guard WIN32 header inclusion