詳解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解釋有待下次添加。