Scintilla的高級技法

爲Scintilla加入代碼摺疊功能

前面曾說過當編輯器有代碼摺疊功能時，25號到31號這7個標記是作爲代碼摺疊專用標記的。在scintilla.h中，我們可以找到它們的定義：

#define SC_MARKNUM_FOLDEREND 25  //摺疊狀態（多級中間）
#define SC_MARKNUM_FOLDEROPENMID 26  //展開狀態（多級中間）
#define SC_MARKNUM_FOLDERMIDTAIL 27  //被摺疊代碼塊尾部（多級中間）
#define SC_MARKNUM_FOLDERTAIL 28  //被摺疊代碼塊尾部
#define SC_MARKNUM_FOLDERSUB 29   //被摺疊的代碼塊
#define SC_MARKNUM_FOLDER 30     //摺疊狀態
#define SC_MARKNUM_FOLDEROPEN 31 //展開狀態

顯示這些標記的掩碼是0xFE000000，同樣頭文件裏已經定義好了：

#define SC_MASK_FOLDERS 0xFE000000

要加入代碼摺疊功能，還有一個最最關鍵的事情，就是要得到語法解析器(Lexer)的支持，上面的這些標記都是由語法解析器自動添加刪除的。一般來說，只要用下面這條命令就可以了讓語法解析器支持代碼摺疊了：

SendEditor(SCI_SETPROPERTY,(sptr_t)"fold",(sptr_t)"1");

是時候上代碼了：

#define MARGIN_FOLD_INDEX 2
void TForm1::setFold()
{
    SendEditor(SCI_SETPROPERTY,(sptr_t)"fold",(sptr_t)"1");

    SendEditor(SCI_SETMARGINTYPEN, MARGIN_FOLD_INDEX, SC_MARGIN_SYMBOL);//頁邊類型
    SendEditor(SCI_SETMARGINMASKN, MARGIN_FOLD_INDEX, SC_MASK_FOLDERS); //頁邊掩碼
    SendEditor(SCI_SETMARGINWIDTHN, MARGIN_FOLD_INDEX, 11); //頁邊寬度
    SendEditor(SCI_SETMARGINSENSITIVEN, MARGIN_FOLD_INDEX, TRUE); //響應鼠標消息

    // 摺疊標籤樣式
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDER, SC_MARK_CIRCLEPLUS);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPEN, SC_MARK_CIRCLEMINUS);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEREND,  SC_MARK_CIRCLEPLUSCONNECTED);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPENMID, SC_MARK_CIRCLEMINUSCONNECTED);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERMIDTAIL, SC_MARK_TCORNERCURVE);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERSUB, SC_MARK_VLINE);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERTAIL, SC_MARK_LCORNERCURVE);

    // 摺疊標籤顏色
    SendEditor(SCI_MARKERSETBACK, SC_MARKNUM_FOLDERSUB, 0xa0a0a0);
    SendEditor(SCI_MARKERSETBACK, SC_MARKNUM_FOLDERMIDTAIL, 0xa0a0a0);
    SendEditor(SCI_MARKERSETBACK, SC_MARKNUM_FOLDERTAIL, 0xa0a0a0);

    SendEditor(SCI_SETFOLDFLAGS, 16|4, 0); //如果摺疊就在摺疊行的上下各畫一條橫線
}
__fastcall TForm1::TForm1(TComponent* Owner)
    : TForm(Owner)
{
    ...
    setFold();
}
void __fastcall TForm1::WndProc(Messages::TMessage &Message)
{
    TForm::WndProc(Message);

    if(Message.Msg == WM_NOTIFY){
        SCNotification* notify = (SCNotification*)Message.LParam;
        if(notify->nmhdr.code == SCN_MARGINCLICK &&
            notify->nmhdr.idFrom == SCINT_ID){
            // 確定是頁邊點擊事件
            const int line_number = SendEditor(SCI_LINEFROMPOSITION,notify->position);
            SendEditor(SCI_TOGGLEFOLD, line_number);
        }
    }
}

現在的效果

 

這裏TForm1::WndProc方法是Scintilla父窗體即我們的TForm1的窗口處理函數。

代碼摺疊以後我們要通過點擊頁邊上的+和-標記來打開和摺疊代碼，所以需要頁邊接收鼠標點擊事件：

SendEditor(SCI_SETMARGINSENSITIVEN, MARGIN_FOLD_INDEX, TRUE); //響應鼠標消息

這樣，當有鼠標點擊該頁邊後，Scintilla就會向它的父窗體發送代碼爲SCN_MARGINCLICK的WM_NOTIFY消息，其中的LParam爲SCNotification*類型。關於SCNotification的詳細信息請參考這裏。SCNotification的position成員指出了點擊位置對應的行號，最後我們用SCI_TOGGLEFOLD命令摺疊或展開代碼。

使用自定義圖形

Scintilla自帶的標記樣式和VS比起來還有差距，反正偶是怎麼調都覺得有點土。Scintilla允許我們自己定義標記的樣式，方法是：

1. 用SCI_MARKERDEFINE命令設置標記的樣式爲SC_MARK_PIXMAP
2. 用SCI_MARKERDEFINEPIXMAP命令設置標記使用的圖形，這裏的圖形要求是xpm格式。

怎樣得到xpm格式圖形

xpm在linux系統下用得比較多，它和BMP、jpg一樣也是一種圖片格式，有不少工具可以把圖片轉換成xpm格式的，比如我喜歡的免費看圖軟件XnView就可以，想必ACDSee也行吧。

xpm比較特殊的地方是它可以作爲頭文件直接被C語言調用，喫驚吧？用文本編輯器打開它看看，呵呵，其實它就是一個數組定義。

如下面這個數據（代碼）就是後面馬上就要用到的minus.xpm和plus.xpm圖片文件的內容(從eclipse裏挖出來的)：

/* XPM */
static const char *minus_xpm[] = {
/* width height num_colors chars_per_pixel */
"     9     9       16            1",
/* colors */
"` c #8c96ac",
". c #c4d0da",
"# c #daecf4",
"a c #ccdeec",
"b c #eceef4",
"c c #e0e5eb",
"d c #a7b7c7",
"e c #e4ecf0",
"f c #d0d8e2",
"g c #b7c5d4",
"h c #fafdfc",
"i c #b4becc",
"j c #d1e6f1",
"k c #e4f2fb",
"l c #ecf6fc",
"m c #d4dfe7",
/* pixels */
"hbc.i.cbh",
"bffeheffb",
"mfllkllfm",
"gjkkkkkji",
"da`````jd",
"ga#j##jai",
"f.k##k#.a",
"#..jkj..#",
"hemgdgc#h"
};

/* XPM */
static const char *plus_xpm[] = {
/* width height num_colors chars_per_pixel */
"     9     9       16            1",
/* colors */
"` c #242e44",
". c #8ea0b5",
"# c #b7d5e4",
"a c #dcf2fc",
"b c #a2b8c8",
"c c #ccd2dc",
"d c #b8c6d4",
"e c #f4f4f4",
"f c #accadc",
"g c #798fa4",
"h c #a4b0c0",
"i c #cde5f0",
"j c #bcdeec",
"k c #ecf1f6",
"l c #acbccc",
"m c #fcfefc",
/* pixels */
"mech.hcem",
"eldikille",
"dlaa`akld",
".#ii`ii#.",
"g#`````fg",
".fjj`jjf.",
"lbji`ijbd",
"khb#idlhk",
"mkd.ghdkm"
};

演示，使用自定義圖形

#include "minus.xpm"
#include "plus.xpm"
void TForm1::setFold()
{
    ...
    // 摺疊標籤樣式
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDER, SC_MARK_PIXMAP);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPEN, SC_MARK_PIXMAP);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEREND,  SC_MARK_PIXMAP);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPENMID, SC_MARK_PIXMAP);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERMIDTAIL, SC_MARK_TCORNERCURVE);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERSUB, SC_MARK_VLINE);
    SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERTAIL, SC_MARK_LCORNERCURVE);

    //
    SendEditor(SCI_MARKERDEFINEPIXMAP, SC_MARKNUM_FOLDER, (sptr_t)plus_xpm);
    SendEditor(SCI_MARKERDEFINEPIXMAP, SC_MARKNUM_FOLDEROPEN, (sptr_t)minus_xpm);
    SendEditor(SCI_MARKERDEFINEPIXMAP, SC_MARKNUM_FOLDEREND, (sptr_t)plus_xpm);
    SendEditor(SCI_MARKERDEFINEPIXMAP, SC_MARKNUM_FOLDEROPENMID, (sptr_t)minus_xpm);
    ...
}

現在，我們的成果是這樣的(與VS有一拼了吧^_^)：