CodeBlocks插件開發(fā)指南(一)

By Lymons(lymons@gmail.com)  2010/4/14

CodeBlocks是一個優(yōu)秀的C/C++ IDE開發(fā)環(huán)境,另外它也是開源的,也是跨平臺的.你能夠利用它的源代碼進(jìn)行二次開發(fā),也能為它制作自己的插件. 它的GUI是利用了跨平臺的wxWidgets庫來做成的,所以它才能夠?qū)崿F(xiàn)跨平臺.

下面將介紹CodeBlock的插件制作方法,當(dāng)然它必須得通過編寫自己的程序才能實(shí)現(xiàn),所以懂得一些C++的編程知識能夠幫你更容易去理解它的內(nèi)容.

1． 準(zhǔn)備CodeBlocks的開發(fā)環(huán)境

①       下載的安裝文件
請到官網(wǎng)(www.codeblocks.org)下載最新版的安裝程序，我當(dāng)時的最新版本是8.02

注意上圖中的第一個文件：codeblocks-8.02-setup.exe 僅僅是一個不帶編譯器的IDE，我們這里需要的是帶編譯器的開發(fā)環(huán)境，所以選擇第二個：codeblocks-8.02mingw-setup.exe（圖中畫紅線的那個） , 這個安裝程序中集成了一個MingW的Gcc編譯器。

②       安裝IDE開發(fā)環(huán)境
安裝非常簡單，只要按照安裝向?qū)нM(jìn)行安裝就沒有問題。
安裝完成后，除了可執(zhí)行程序本身之外，在安裝目錄下還會創(chuàng)建一個MinGW目錄，它就是CodeBlocks的默認(rèn)編譯器Gnu Gcc.

③       下載zip工具
CodeBlocks在編譯插件的時候需要把 .dll文件和.cbplugin文件壓縮成.zip文件，所以我們需要用到zip命令。
請到zip作者的主頁(http://www.info-zip.org/) 去下載Windows版的zip命令。
#注意：該網(wǎng)站上的大部分連接都訪問不了，也可以下在我這里提供的壓縮包。

下載完畢后，請把壓縮包中的可執(zhí)行文件zip.exe拷貝到上面的MinGW的bin目錄下。

2． 準(zhǔn)備wxWidget編譯環(huán)境
因?yàn)?/span>CodeBlocks的窗口系統(tǒng)使用的wxWidgets這個跨平臺的GUI開發(fā)庫。所以，它的插件也要使用wxWidgets進(jìn)行開發(fā)。所以，我們首先做成wxWidgets的編譯環(huán)境。

①       下載源代碼
#注意：一定要下載源代碼，不要圖省事兒就去下載編譯好的安裝文件。因?yàn)樵蹅冮_發(fā)的時候需要的都是可調(diào)試版本的wxWidgets的庫，而安裝文件中往往包含的都是發(fā)布版的庫文件；另外，CodeBlocks的插件工程關(guān)聯(lián)的是gcc_dll目錄下的wxWidgets的庫文件，發(fā)布版中則沒有它，需要編譯wxWidgets的源代碼才會出現(xiàn)這個目錄。
到官網(wǎng)(http://www.wxwidgets.org/) 上下載wxWidget的穩(wěn)定版。因?yàn)?/span>CodeBlocks的版本是8.02版，它是基于2.8版本的wxWidget開發(fā)的，所以我們選擇的是2.8.10版本的wxWidget. 下載地址：
http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.10.tar.gz

②       解壓縮
請使用7-zip或者winrar來解壓縮你下載的.tar.gz壓縮包。
#注意：請不要把wxWidgets的源代碼放到Program Files這樣的中間帶一個空格的目錄下，因?yàn)?/span>CodeBlocks8.02在解析帶有空格的路徑時會存在一個錯誤(我想著應(yīng)該是一個bug)。最好能把wxWidgets放置到磁盤的根目錄下。

③       設(shè)置MingW編譯器的path的環(huán)境變量

A)      執(zhí)行cmd.exe命令，打開DOS窗口

B)      在PATH環(huán)境變量中添加編譯器的路徑
這個路徑就是剛才咱們安裝到CodeBlocks下的MinGW的路徑。開發(fā)程序時，我們需要用的編譯器的可執(zhí)行文件在以下的兩個路徑下：
F:\Program Files\CodeBlocks\MinGW\bin
F:\Program Files\CodeBlocks\MinGW\libexec\gcc\mingw32\3.4.5
因此使用下面的命令把上面的兩個路徑加入到PATH環(huán)境變量中：
set path=%PATH%; F:\Program Files\CodeBlocks\MinGW\bin; F:\Program Files\CodeBlocks\MinGW\libexec\gcc\mingw32\3.4.5

請注意：在每一個路徑之間都必須用分號進(jìn)行隔開。

④       編譯wxWidget

A)      在Dos窗口中進(jìn)入到wxWidgets的安裝目錄下：
wxWidgets的編譯文件被放在build目錄下，其中msw目錄存放的就是Windows下的編譯配置文件。 這里我們的編譯器是GCC,所以要使用該目錄下的配置文件：ｍａｋｅｆｉｌｅ．ｇｃｃ

B)      用MinGW的GCC編譯器來編譯wxWidgets
首先是清除原來編譯的垃圾文件：
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1 clean

然后實(shí)施真正的編譯：
mingw32-make -f makefile.gcc SHARED=1 MONOLITHIC=1 BUILD=release UNICODE=1

在這里我們是編譯的是release版本，如果你想要攜帶一些調(diào)試信息，在這里你也可以編譯它的debug版本。只需要把命令中的release換成debug即可。

C)      如果編譯成功，在F:\wxWidgets-2.8.10\lib目錄下創(chuàng)建一個叫gcc_dll的目錄

這個目錄很重要，在CodeBlocks編譯程序文件時，它會自動去找gcc_dll目下的靜態(tài)庫；而從網(wǎng)上下載的官方編譯好的庫文件中卻沒有這個目錄。下面是gcc_dll目錄下的文件：

如果上面lib/gcc_dll目錄被成功的創(chuàng)建，目錄下也生成了上述的庫文件，恭喜你，你得wxWidgets已經(jīng)編譯成功了。

⑤       在CodeBlocks中設(shè)置wx變量

A)      執(zhí)行codeblocks.exe命令打開CodeBlocks的IDE環(huán)境

B)      在主菜單中選擇Settings -> Global variables

C)      此時會打開環(huán)境變量編輯器

我們要對上面的Current Variable, 和 base 進(jìn)行設(shè)置。

D)      點(diǎn)擊Current Variable下拉列表框，選擇wx

注意：圖中的cb是后面要用到的環(huán)境變量，它是CodeBlocks開發(fā)庫本身的環(huán)境變量，編譯插件的時候需要用到它。所以，它也應(yīng)該被設(shè)置。設(shè)置方法同wx的設(shè)置。

E)      在base中設(shè)置wxWidgets的根目錄
點(diǎn)擊 … 按鈕，找到wxWidgets的根目錄，設(shè)定即可。我們這里的根目錄是：F:\wxWidgets-2.8.10

將來cb這個環(huán)境變量也是同樣的進(jìn)行設(shè)置。
注意：include, lib的路徑不用設(shè)置，因?yàn)?/span>CodeBlocks會根據(jù)base的路徑自動引用base下的include,lib的路徑。

3． 準(zhǔn)備CodeBlocks編譯環(huán)境
CodeBlocks在編譯插件的時候需要用，CodeBlocks的SDK開發(fā)庫(sdk.h , libcodeblocks.a, libwxscintilla.a)。 而CodeBlocks的IDE安裝程序中并沒有這些東西，所以需要我們根據(jù)CodeBlocks的源代碼，把它編譯成我們所需要的庫。

①       下載源代碼
請到官網(wǎng)(www.codeblocks.org)下載8.02版的源程序，注意請不要下載最新版的源程序，因?yàn)樽钚掳娴?/span>CodeBlocks可能關(guān)聯(lián)上了2.8.10以后的wxWidgets,所以在編譯的時候會出現(xiàn)：找不到wx/scintilla.h文件 這樣的錯誤。
下載地址：
http://downloads.sourceforge.net/codeblocks/codeblocks-8.02-src.tar.bz2

②       解壓縮
請使用7-zip或者winrar來解壓縮你下載的.tar.gz壓縮包。

③       用CodeBlocks打開CodeBlocks的源代碼工程文件
進(jìn)入CodeBlocks的源代碼目錄，CodeBlocks.cbp就是工程文件。如果該文件已經(jīng)被CodeBlocks關(guān)聯(lián)上的的話，鼠標(biāo)雙擊這個文件就可以打開CodeBlocks的源代碼工程。

如果.cbp沒有被CodeBlocks關(guān)聯(lián)的話，你可以從CodeBlocks的File主菜單中選擇Open…打開上面目錄中的CodeBlocks.cbp文件。

④       Build全工程
從CodeBlocks的主菜單中選擇 Build -> Build workspace, 就可以編譯整個工程了。

如果編譯成功，則會在codeblocks-8.02\src目錄下生成devel目錄

該目錄存放的是編譯好的codeblocks可執(zhí)行文件，以及相關(guān)的庫，這個庫中最重要的是libcodeblocks.a, 這個庫是將來在編譯插件時需要的一個最重要的庫文件(sdk.h頭文件中接口都被包含在這個靜態(tài)庫里) 另外還有share目錄，該目錄是編譯好的插件

到這步為止，咱們在系統(tǒng)里就有兩個CodeBlocks的可執(zhí)行文件了。一個是最開始我們直接安裝的IDE開發(fā)環(huán)境，另一個則是我們現(xiàn)在根據(jù)源代碼編譯出來的可執(zhí)行文件。而后面要提到的運(yùn)行和調(diào)試插件就是用到目前這個codeblocks.exe.

然后，把libcodeblocks.a, libwxscintilla.a拷貝到先前安裝的CodeBlocks的IDE環(huán)境的目錄下，因?yàn)樵诰幾g插件的時候，需要用到它們。
我這里的目錄是：
F:\Program Files\CodeBlocks

⑤       執(zhí)行update.bat
進(jìn)入到codeblocks-8.02/src目錄下，執(zhí)行update.bat批處理文件。該文件的作用把devel目錄下的文件拷貝到output目錄下，不過debug信息會被剔除。

其實(shí)，這步不做也可以。因?yàn)?/span>output下的東西我們幾乎不會用到。

⑥       設(shè)置CodeBlocks中設(shè)置cb變量
在全局環(huán)境變量編輯器中設(shè)置cb的base路徑為存放CodeBlocks源代碼的目錄，即codeblocks-8.02/src目錄。我們這里是：
F:\Program Files\CodeBlocks\codeblocks-8.02\src
具體的設(shè)置方法跟wx變量的設(shè)置方法一樣。

到目前為止，所有的編譯前的準(zhǔn)備都完成了。接下來就可以創(chuàng)建一個Plugin工程，來做成我們自己的插件了。

下面的內(nèi)容將在<<CodeBlock插件開發(fā)指南 二>>中進(jìn)行講解.

4． 創(chuàng)建Plugin工程
<<CodeBlock插件開發(fā)指南 二>>

5． 添加右鍵彈出菜單
CodeBlocks插件開發(fā)指南(三)

6． 主菜單中添加下拉菜單
CodeBlocks插件開發(fā)指南(三)

7． 添加工具條

8． 在”Log&others”中添加一個面板(Panel)

9． 添加一個單獨(dú)的面板