CodeBlocks插件開發指南(二)
By Lymons(lymons@gmail.com) 2010/4/14

1． 創建Plugin工程

①       從File主菜單中，選擇new -> Projects… , 打開工程創建向導對話框。

②       在Projects的列表框中，選擇 Code::Blocks plugin ，然后點擊 Go 按鈕，進入插件創建向導對話框。

③       創建向導的第一個畫面中有重要信息說明。請注意的是里面提到了必須設置#cb, #wx這兩個全局變量。不過，還好咱們在《CodeBlock插件開發指南 一》中已經對這兩個變量進行了設置。
咱們在這里，直接點擊Next進入到下一個畫面即可。

④       在下面這個畫面，要設定工程標題（Project title）和工程目錄（Folder to create project in:）。 首先要填寫Project title，也就是要寫入工程的名字。如果，工程標題和工程目錄決定了，Project filename和 Resulting filename 會自動生成。
注意：CodeBlocks的工程文件的后綴名是.cbp
各項目都設定完畢后，點擊Next進入到下一個畫面

⑤       下面是設置插件的名字，也就是將來編譯成功后，系統自動做成的插件的名字.例如，如果在這里把 Plugin name 設定成 testplug 的話，將來會在工程目錄下生成：testplugin.zip, testplugin.dll, testplugin.cbplugin 這個三個文件。


在Plugin name 中填入你想要的插件名字。盡可能的話請使用英文。
在Plugin type 的下拉列表框中有四項：
     1. Generic
     2. Tool
     3. MIME handler
     4. Wizard
在Options中有四個選項：
     1. Provides configuration dialog　提供配置對話框
     2. Creates menu entries 提供主菜單入口
     3. Creates popup men entries 提供視圖上的彈出菜單入口
     4. Creates toolbar 提供工具條
上述的四個選項就是插件提供給用戶的四種gui接口。
默認情況下，只有第一項是可選項。如果想要四個選項都可選，則需要選擇Plugin type中的Generic。為了把每個項目都進行說明，我們這里選擇的是Generic

選擇Generic后，Options的四個選項全部變成可選狀態。
我們把這四個選項都選上，然后點擊Next, 就進入到下一個畫面

⑥       這個畫面是設定插件的版本，版權信息，因為是說明性的工程，在這里我們什么也沒有填寫。你可以根據自己的意愿隨便進行填寫。

⑦       因為插件的GUI是用的是wxWidgets窗口庫，所以要在這里選擇插件所依賴的版本。
我們在這里選擇wxWidgets 2.8.x。大家應該還記得在前面我們已經安裝了wxWidgets 2.8.10吧。然后，點擊Next進入下一畫面。

⑧       下面是選擇編譯器，這是向導對話框中的最后一個畫面。我們選擇GNU GCC Complier，然后點擊Finish完成插件工程的創建。

恭喜你，到目前為止，你就創建了一個CodeBlocks的插件工程了。

正常的情況下，該工程只包含一個.cpp文件和一個.h文件，這個文件根據你的插件名字來生成。我們這里就是testplug.cpp 和 testplug.h


注意，在testplug.cpp中包含了sdk.h 和 configurationpanel.h 這兩個頭文件，他們位于CodeBlocks開發庫中，是開發插件必不可少的兩個頭文件。而插件在連接是所需要的靜態庫是前面編譯出來的libcodeblocks.a

讓我們看看，這個插件里主要的東西：插件類的定義

文件wx/wxprec.h, wx/wx.h 是wxWidgets庫的頭文件。
大家可以看到，插件的類的名字是 testplug, 它繼承與cbPlugin, 基類cbPlugin的定義在 cbplugin.h里。

2． 編譯&加載插件

①       現在我們可以從Build主菜單中選擇Build workspace來編譯這個插件工程了。不出意外的話，應該是正常編譯通過的。如果你有編譯錯誤的話，請你參考《CodeBlock插件開發指南 一》來配置編譯環境。

如果編譯成功的話，應該會在工程目錄下生成如下文件：


其中有三個是最重要的文件
    1. testplug.cbplugin
        CodeBlocks在載入插件時所需要的文件
    2. testplug.dll
        插件的實現被封裝到這個dll文件中
    3. testplug.zip.
        包含了插件的版本信息，壓縮包里最主要就是manifest.xml
不過，大家會發現，這些文件中沒有可執行文件。這是因為，插件本身并不是一個能夠獨立運行的可執行文件，它僅僅是一個dll，它是要依附于CodeBlocks來生存的。

②       現在我們可以嘗試用CodeBlocks來載入剛才我們生成的插件。在Build主菜單中選擇Run就可以運行這個插件了。

③       嗯，奇怪了，點擊Run后，運行的怎么是Codeblocks呢。

這就對了，這里Run（運行）的不是插件，而是裝載插件的CodeBlocks的IDE環境，而我們是要在這個IDE中加載剛才我們創建的那個插件。
值得注意的是，這里被運行起來的IDE環境是在前面我們編譯成功的那個codeblocks.exe, 大家還記得吧，這個可執行文件在codeblocks-8.02\src\devel目錄下。如果忘記了，請參考《CodeBlock插件開發指南 一》的3-④ 。
#注意，如果點擊Run菜單項后，codeblocks不能被運行的話，有原因可能是CodeBlocks默認設定了”只允許運行一個實例”。所以，我們可以把這個設定去掉。我們從Settings菜單中選擇 Environments…


此時，會彈出Environment settings對話框，然后我們選擇左邊的 General settings屬性頁。
在屬性頁中把 “Allow only once running instance(needs application restart to take effect)”項目前面的√對號符選掉。
然后重新啟動CodeBlocks生效此配置。

④       如果，另一個CodeBlocks能夠被正確啟動，我們就要嘗試載入剛才我們創建成功的插件。我們應該從Plugins主菜單中選擇 Manage plugins…
會彈出 Manage plugins對話框，然后我們點擊右邊的按鈕 Install new


會彈出 Select plugin to install 文件選擇對話框，此時我們定位到我們的插件工程目錄中，選擇目錄里面的testplug.cbplugin文件就可以了。


如果加載成功的話，我們會在Installed plugins: 中看到剛才我們載入的testplug插件，其實CodeBlocks載入就是我們編譯成功的testplug.dll文件。

⑤       大家會發現，成功載入插件后，不管我們怎么操作都不能發現插件的用戶接口在哪兒。這是因為，我們僅僅是創建了一個空的插件工程，該工程里只提供了各種GUI方式的接口函數，并沒有任何代碼實現，所以不會看到該插件有什么效果的。

唯一能看到視覺效果的是它的About對話框


這個對話框中，什么信息都沒有。不過你應該可以定制它的內容。



到目前為止，你應該知道如何創建以及運行一個插件了。接下來我們要涉及到具體的編碼了。
  

2． 添加右鍵彈出菜單

3． 主菜單中添加下拉菜單

4． 添加工具條

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

6． 添加一個單獨的面板

7． 運行

①       Run

②       載入編譯好的插件