詳解Cocos2d-X中宏CC_DLL

在cocos2d-x的源碼中，經常可以看到宏CC_DLL的使用，比如在類CCScene的定義中：

class CC_DLL CCScene : public CCNode
{
public:
        CCScene();
        virtual ~CCScene();
        bool init();

        static CCScene *create(void);
};

在cocos2d-x中，根據不同的平台，宏CC_DLL的定義是不同的，在iOS/Android/Blackberry/Mac平台上，CC_DLL代表“空”：

#define CC_DLL

在win32平台上，CC_DLL的定義為：

#if defined(_USRDLL)
    #define CC_DLL     __declspec(dllexport)
#else         /* use a DLL library */
    #define CC_DLL     __declspec(dllimport)
#endif

在linux平台上，CC_DLL的定義為：

#if defined(_USRDLL)
#define CC_DLL __attribute__ ((visibility ("default")))
#else         /* use a DLL library */
#define CC_DLL __attribute__ ((visibility ("default")))
#endif

對於win32，需要明白__declspec(dllexport)和__declspec(dllimport)的功能。

__declspec(dllexport)

聲明一個導出函數，是說這個函數要從本DLL導出。我要給別人用。一般用於dll中省掉在DEF文件中手工定義導出哪些函數的一個方法。當然，如果你的DLL里全是C++的類的話，你無法在DEF里指定導出的函數，只能用__declspec(dllexport)導出類。

//SimpleDLLClass.h

#ifdef SIMPLEDLL_EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT
#endif

class DLL_EXPORT SimpleDLLClass
{
public: 
    SimpleDLLClass(); 
    virtual ~SimpleDLLClass(); 
    virtual getValue() { return m_nValue;};
private: 
    int m_nValue;
};

//SimpleDLLClass.cpp

#include "SimpleDLLClass.h"

SimpleDLLClass::SimpleDLLClass()
{ 
    m_nValue=0;
}

SimpleDLLClass::~SimpleDLLClass()
{
}

對於上述代碼，如果定義了SIMPLEDLL_EXPORT，那上述代碼會被編譯生成dll文件，此dll文件會向其他程序模塊提供類SimpleDLLClass的函數和變量調用。

 

__declspec(dllimport)

聲明一個導入函數，是說這個函數是從別的DLL導入。我要用。一般用於使用某個dll的exe中 。

不使用 __declspec(dllimport) 也能正確編譯代碼，但使用 __declspec(dllimport) 使編譯器可以生成更好的代碼。編譯器之所以能夠生成更好的代碼，是因為它可以確定函數是否存在於 DLL 中，這使得編譯器可以生成跳過間接尋址級別的代碼，而這些代碼通常會出現在跨 DLL 邊界的函數調用中。但是，必須使用 __declspec(dllimport) 才能導入 DLL 中使用的變量。

在Windows DLL編程時，可使用__declspec(dllimport)關鍵字導入函數或者變量。

函數的導入

    當你需要使用DLL中的函數時，往往不需要顯示地導入函數，編譯器可自動完成。但如果你顯示地導入函數，編譯器會產生質量更好的代碼。由於編譯器確切地知道了一個函數是否在一個DLL中，它就可以產生更好的代碼，不再需要間接的調用轉接。

 

    Win32的PE格式（Portable Executable Format）把所有導入地址放在一個導入地址表中。下面用一個具體實例說明使用__declspec(dllimport)導入函數和不使用的區別：

 

    假設func是一個DLL中的函數，現在在要生成的.exe的main函數中調用func函數，並且不顯示地導入func函數（即沒有：__declspec(dllimport)），代碼示例如下：

int main()
{
    func();
}

編譯器將產生類似這樣的調用代碼：

call func

然后，鏈接器把該調用翻譯為類似這樣的代碼：

call 0x40000001; //0x40000001是func的地址

並且，鏈接器將產生一個Thunk，形如：

0x40000001: jmp DWORD PTR __imp_func

這里的imp_func是func函數在.exe的導入地址表中的函數槽的地址。然后，加載器只需要在加載時更新.exe的導入地址表即可。

 

    而如果使用了__declspec(dllimport)顯示地導入函數，那么鏈接器就不會產生Thunk（如果不被要求的話），而直接產生一個間接調用。因此，下面的代碼：

__declspec(dllimport) void func1(void);

void main(void) 
{
    func1();
}

將調用如下調用指令：

call DWORD PTR __imp_func1

因此，顯示地導入函數能有效減少目標代碼（因為不產生Thunk）。另外，在DLL中使用DLL外的函數也可以這樣做，從而提高空間和時間效率。

變量的導入

    與函數不同的是，在使用DLL中的變量時，需要顯示地導入變量。使用__declspec(dllimport)關鍵字導入變量。若在DLL中使用.def導出變量，則應使用DATA修飾變量，而不是使用已經被遺棄的CONSTANT。因為CONSTANT可能需要使用指針間接訪問變量，不確定什么時候會出問題。

 我相信寫WIN32程序的人，做過DLL，都會很清楚__declspec(dllexport)的作用，它就是為了省掉在DEF文件中手工定義導出哪些 函數的一個方法。當然，如果你的DLL里全是C++的類的話，你無法在DEF里指定導出的函數，只能用__declspec(dllexport)導出 類。但是，MSDN文檔里面，對於__declspec(dllimport)的說明讓人感覺有點奇怪，先來看看MSDN里面是怎么說的： 

不使用 __declspec(dllimport) 也能正確編譯代碼，但使用 __declspec(dllimport) 使編譯器可以生成更好的代碼。編譯器之所以能夠生成更好的代碼，是因為它可以確定函數是否存在於 DLL 中，這使得編譯器可以生成跳過間接尋址級別的代碼，而這些代碼通常會出現在跨 DLL 邊界的函數調用中。但是，必須使用 __declspec(dllimport) 才能導入 DLL 中使用的變量。

初看起來，這段話前面的意思是，不用它也可以正常使用DLL的導出庫，但最后一句話又說，必須使用 __declspec(dllimport) 才能導入 DLL 中使用的變量這個是什么意思？？

那我就來試驗一下，假定，你在DLL里只導出一個簡單的類，我們在下面的代碼中導入使用這個DLL中的類，注意，我假定你已經在項目屬性中定義了 SIMPLEDLL_EXPORT。

//SimpleDLLClass.h

#ifdef SIMPLEDLL_EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT
#endif

class DLL_EXPORT SimpleDLLClass
{
public: 
    SimpleDLLClass(); 
    virtual ~SimpleDLLClass(); 
    virtual getValue() { return m_nValue;};
private: 
    int m_nValue;
};

//SimpleDLLClass.cpp

#include "SimpleDLLClass.h"

SimpleDLLClass::SimpleDLLClass()
{ 
    m_nValue=0;
}

SimpleDLLClass::~SimpleDLLClass()
{
}

然后你再使用這個DLL類，在你的APP中include SimpleDLLClass.h時，你的APP的項目不用定義 SIMPLEDLL_EXPORT 所以，DLL_EXPORT 就不會存在了，這個時候，你在APP中，不會遇到問題。這正好對應MSDN上說的__declspec(dllimport)定義與否都可以正常使用。但我們也沒有遇到變量不能正常使用呀。 那好，我們改一下SimpleDLLClass,把它的m_nValue改成static,然后在cpp文件中加一行int SimpleDLLClass::m_nValue=0;如果你不知道為什么要加這一行，那就回去看看C++的基礎。

改完之后，再去LINK一下，你的APP，看結果如何， 結果是LINK告訴你找不到這個m_nValue。明明已經定義了，為什么又沒有了？？ 肯定是因為我把m_nValue定義為static的原因。但如果我一定要使用Singleton的Design Pattern的話，那這個類肯定是要有一個靜態成員，每次LINK都沒有，那不是完了？ 如果你有Platform SDK，用里面的Depend程序看一下，DLL中又的確是有這個m_nValue導出的呀。

再回去看看我引用MSDN的那段話的最后一句。 那我們再改一下SimpleDLLClass.h，把那段改成下面的樣子:

#ifdef SIMPLEDLL_EXPORT
#define DLL_EXPORT __declspec(dllexport)
#else
#define DLL_EXPORT __declspec(dllimport)
#endif

再LINK，一切正常。原來dllimport是為了更好的處理類中的靜態成員變量的，如果沒有靜態成員變量，那么這個__declspec(dllimport)無所謂。

 關於__declspec(dllexport)和__declspec(dllimport)的使用，參考了這篇博文：http://www.cnblogs.com/xd502djj/archive/2010/09/21/1832493.html

 關於linux平台上的CC_DLL解釋有待下次添加。