引言
有時候看到論壇上有人問編譯時重定義現象的問題。這個問題與頭文件包含沖突有關,改一改相關頭文件包含就會讓問題消失。我在這裡要以 <windows.h> <winsock.h> <winsock2.h>這3個頭文件為例分析為什麼會產生這種原因;然後給出一種不會產生沖突的做法;最後就此例的分析給出結論。本文對於已經知道沖突原因的讀者是多余的,但對於一時沒有時間去解的人還是有一定的參考價值的。
一個重命名的例子
先寫一個socket基本操作類:
// SocketBase.h
#ifndef _SOCKET_BASE_H_
#define _SOCKET_BASE_H_
#include <winsock2.h>
#pragma comment(lib, "ws32_2.lib")
class Socket
{
};
#endif
寫一個TCP監聽類,它從Socket派生:
// TcpListener.h
#ifndef _TCP_LISTENER_H_
#define _TCP_LISTENER_H_
#include "SocketBase.h"
class TcpListener : Socket
{
};
#endif
在基於MFC的工程中用 TcpListener 監聽客戶連接,同時這個地方須要用到 Windows 某些頭文件。
#include "stdafx.h"
#include "TcpListener.h"
void fun()
{
TcpListener* listen = new TcpListener;
……
}
下面是頭文件包含關系:
Stdafx.h -> windows.h -> winsock.h winsock2.h
TcpListener.h -> SocketBase.h -> winsock2.h
編譯,出現N多重定義錯誤。這個錯誤與stdafx.h中的 windows.h 和TcpListener.h 的 winsock2.h 有關,下面說兩種消除錯誤的方法。
針對本工程中消除編譯
錯誤產生的原因是 windows.h 中有:
#include <winsock.h>
#include <winsock2.h>
產生重定義的是 windows.h 中的 winsock.h 相關定義與 TcpListener.h 中 winsock2.h 相關定義沖突。相同頭文件是不會沖突的,因為有 "#ifndef #define …. #endif";如果windows中只包含一個winsock2.h就不會產生重定義了。
現在我們只要把 SocketBase.h 中的 "include <winsock2.h> 和 #pragma…"注釋了就編譯通過了。但經過注釋的 SocketBase.cpp 與 TcpListener.cpp 單獨編譯就通不過了。這種只是針對特定的環境下解決問題,我們得想一個比較專業的辦法。
一個可被接受的解決方法
Winsock2.h 與 windows.h 中的 winsock.h 相關項的重定義要在 SocketBase.h 中避免。在 SocketBase.h加一些編譯條件就可以做到這一點,經過修改的 SockBase.h 如下:
#ifndef _SOCKET_BASE_H_
#define _SOCKET_BASE_H_
#ifndef _WINSOCKAPI_ // 沒有包含winsock.h
#define _WINSOCKAPI_ // 避免再包含winsock.h
#ifndef _WINSOCK2API_ // 沒有包含winsock2.h
#define _WINSOCK2API_ // 避免再包含winsock2.h
#include <winsock2.h>
#pragma comment(lib, "ws32_2.lib")
#endif
#endif
class Socket
{
};
#endif
經過這樣修改,就能做到 winsock.h 與 winsock2.h 中的相關項重定義了。
結論
通過對上述例子的分析解決,同樣在其它類似的問題中適用。如果有更簡單的方法避免重定義的情況出現,請告訴我一下。
參考
Win32 sdk中的 windows.h;
Win32 sdk中的 winsock.h;
Win32 sdk中的 winsock2.h;