Scintilla开源库使用指南(编辑器篇)（二）

Scintilla开源库使用指南（二）

上一篇文章介绍了Scintilla的基本应用，这里继续学习Scintilla更多的控制命令和实现细节，完善我们的编辑器；

页边(Margins)和标记(Markers)

代码折叠是现代IDE和代码编辑器的必备功能，如果现在推出一个不支持折叠的编辑器，那是要被BS地~~。为了不被BS，很有必要先“研究”一下Scintilla的页边(Margins)和标记(Markers)功能。

• 页 边(Margins)：页边是位于文本显示区左边的一竖条区域，它可以用于显示行号、书签、断点标记等东东。Scintilla最多可以有5个页边（从左 到右的编号为0~4），每个页边可以使用SCI_SETMARGINTYPEN命令确定是用于显示行号还是符号。我们可以用 SCI_SETMARGINWIDTHN命令控制一个页边的宽度，如果设置为0，则表示不显示该页边。默认是只显示宽度为16的1号页边。
• 标 记(Markers)：标记，不用说也知道是用来标记文本位置（确切地说，是文本行）的。我们可以使用32种标记（编号0~31），我们可以自由决定这 32种标记的意义，如标记0用来表示断点、标记1~10表示书签、标记20表示语法错误行等等。不过，如果编辑器要支持代码折叠功能，我们得把标记 25~31留出来，把这7个标记作为代码折叠专用标记（后面还会讲到）。

告诉页边显示哪些标记

当页边不是设定为显示行号时（由SCI_SETMARGINTYPEN命令设置），那么它就会显示标记。刚才说过Scintilla有32种标记，一般来说不会让一个页边来显示所有的标记，而是只显示部分标记。

在一个页边里可以显示哪几种标记由SCI_SETMARGINMASKN命令设置，它的参数是一个32位掩码（mask）值，掩码值的第n位为1时表示该页边可显示n号标记。

所有页边相关的命令以SCI_SETMARGIN或SCI_GETMARGIN作为前缀，如：

• SCI_SETMARGINTYPEN(int margin, int type)  设置页边显示行号还是符号，type可以是SC_MARGIN_SYMBOL或SC_MARGIN_NUMBER
• SCI_SETMARGINWIDTHN(int margin, int pixelWidth)  设置页边宽度
• SCI_SETMARGINMASKN(int margin, int mask)  设置页边掩码
• SCI_SETMARGINSENSITIVEN(int margin, bool sensitive)  设置页边是否接受鼠标点击事件

所有标记相关的命令以SCI_MARKER作为前缀，如：

• SCI_MARKERADD(int line, int markerNumber)  在指定行加入一个markerNumber号标记
• SCI_MARKERDEFINE(int markerNumber, int markerSymbols)  定义markerNumber号标记的样式
• SCI_MARKERDELETE(int line, int markerNumber) 在指定行上的删除markerNumber号标记
• SCI_MARKERDELETEALL(int markerNumber) 删除文本中所有markerNumber号标记
• SCI_MARKERSETFORE(int markerNumber, int colour) 为markerNumber号标记指定前景色
• SCI_MARKERSETBACK(int markerNumber, int colour) 为markerNumber号标记指定背景色

?

// 标记和页边演示 void  TForm1::example() {      // 先写10行文本上去      for ( int  i=0; i<10; i++)          SendEditor(SCI_APPENDTEXT, 12, (sptr_t) "hello world " );      // 0号页边，宽度为9，显示0号标记(0..0001B)      SendEditor(SCI_SETMARGINTYPEN,0,SC_MARGIN_SYMBOL);      SendEditor(SCI_SETMARGINWIDTHN,0, 9);      SendEditor(SCI_SETMARGINMASKN,0, 0x01);      // 1号页边，宽度为9，显示1,2号标记(0..0110B)      SendEditor(SCI_SETMARGINTYPEN,1, SC_MARGIN_SYMBOL);      SendEditor(SCI_SETMARGINWIDTHN,1, 9);      SendEditor(SCI_SETMARGINMASKN,1, 0x06);      // 2号页边，宽度为20，显示行号      SendEditor(SCI_SETMARGINTYPEN,2, SC_MARGIN_NUMBER);      SendEditor(SCI_SETMARGINWIDTHN,2, 20);          for ( int  i=0; i<10; i++)      {          // 前10行分别加入0~2号标记          SendEditor(SCI_MARKERADD, i, i%3);      }          // 设置标记的前景色      SendEditor(SCI_MARKERSETFORE,0,0x0000ff); //0-红色      SendEditor(SCI_MARKERSETFORE,1,0x00ff00); //1-绿色      SendEditor(SCI_MARKERSETFORE,2,0xff0000); //2-蓝色 }

显示效果是：

如果你不喜欢这些圆圈，可以用SCI_MARKERDEFINE命令改变标记的样式，可选的有：

默认是SC_MARK_CIRCLE，小圆圈。你可以试试其它的。（注意SC_MARK_CHARACTER比较特殊，它和一个ASCII码加起来决定标记显示为一个对应的ASCII字符）

有了这些基础，我们可以动手为Scintilla加入代码折叠功能了...

为Scintilla加入代码折叠功能

前面曾说过当编辑器有代码折叠功能时，25号到31号这7个标记是作为代码折叠专用标记的。在scintilla.h中，我们可以找到它们的定义：

这里TForm1::WndProc方法是Scintilla父窗体即我们的TForm1的窗口处理函数。

代码折叠以后我们要通过点击页边上的+和-标记来打开和折叠代码，所以需要页边接收鼠标点击事件：

这里TForm1::WndProc方法是Scintilla父窗体即我们的TForm1的窗口处理函数。

代码折叠以后我们要通过点击页边上的+和-标记来打开和折叠代码，所以需要页边接收鼠标点击事件：

?

/* 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有一拼了吧^_^)：

怎样支持自动缩进

在VS里编写C++代码时，输入回车换行后会保持和上一行的缩进一致，输入"{'字符后回车还会帮我们多缩进一次，输入'}'后又能自动退回。我们的编辑器也要实现这个功能。

现在再仔细了解一下Scintilla的通知消息（http://scintilla.sourceforge.net/ScintillaDoc.html#Notifications），除了前面用到的页边点击事件外，还有很多事件非常有用。

实现自动缩进功能我们要关心的事件通知是SCN_CHARADDED和SCN_UPDATEUI。

• 当用户输入一个字符时，SCN_CHARADDED事件触发，SCNotification的ch成员保存了输入的字符。
• 当更新文档界面时，SCN_UPDATEUI事件触发。输入字符，改变字体风格，改变选区都会引起界面更新

演示代码

改写TForm1::WndProc，处理这两个事件，我们的编辑器支持自动缩进啦

?

void  __fastcall TForm1::WndProc(Messages::TMessage &Message) {      TForm::WndProc(Message);          if (Message.Msg == WM_NOTIFY)      {          ...          // 处理自动缩进          static  int  LastProcessedChar = 0;          //在CharAdded事件中记录最后输入的字符          if (notify->nmhdr.code == SCN_CHARADDED)          {              LastProcessedChar = notify->ch;          }          // 在UpdateUI事件中处理缩进          if (notify->nmhdr.code == SCN_UPDATEUI && LastProcessedChar!=0)          {              int  pos = SendEditor(SCI_GETCURRENTPOS); //取得当前位置              int  line = SendEditor(SCI_LINEFROMPOSITION,pos); //取得当前行              //如果最后输入的字符是右括号的话就自动让当前行缩进和它匹配的左括号所在行一致              if ( strchr ( "})>]" ,LastProcessedChar) &&                  isspace (SendEditor(SCI_GETCHARAT,pos-2)) && //要求右括号左边是空白字符                  LastProcessedChar!=0)              {                  //找前一个单词起始位置，这里用它来确定右括号左边是否全是空白字符                  int  startpos = SendEditor(SCI_WORDSTARTPOSITION,pos-1, false );                  int  linepos = SendEditor(SCI_POSITIONFROMLINE,line); //当前行起始位置                  if (startpos == linepos) //这样相当于判断右括号左边是否全是空白字符                  {                      int  othpos = SendEditor(SCI_BRACEMATCH,pos-1); //得到对应的左括号所在的位置                      int  othline = SendEditor(SCI_LINEFROMPOSITION,othpos);  //左括号所在行                      int  nIndent = SendEditor(SCI_GETLINEINDENTATION,othline); //左括号所在行的缩进值                      // 替换右括号前面的空白字符，使之与左括号缩进一致                      char  space[1024];                      memset (space, ' ' ,1024);                      SendEditor(SCI_SETTARGETSTART, startpos);                      SendEditor(SCI_SETTARGETEND, pos-1);                      SendEditor(SCI_REPLACETARGET,nIndent,(sptr_t)space);                  }              }              // 如果输入的是回车，则保持与上一行缩进一致              // 如果上一行最后有效字符为左括号，就多缩进四个空格              if (LastProcessedChar == ' ' )              {                  if (line > 0)                  {                      // 得到上一行缩进设置                      int  nIndent = SendEditor(SCI_GETLINEINDENTATION,line-1);                      // 查找上一行最后一个有效字符（非空白字符）                      int  nPrevLinePos = SendEditor(SCI_POSITIONFROMLINE,line-1);                      int  c = ' ' ;                      for ( int  p = pos-2;                          p>=nPrevLinePos && isspace (c);                          p--, c=SendEditor(SCI_GETCHARAT,p));                      // 如果是左括号，就多缩进四格                      if (c && strchr ( "{([<" ,c)) nIndent+=4;                      // 缩进...                      char  space[1024];                      memset (space, ' ' ,1024);                      space[nIndent] = 0;                      SendEditor(SCI_REPLACESEL, 0, (sptr_t)space);                  }              }              LastProcessedChar = 0;          }      } }

下面是代码中用到的Scintilla命令的简单介绍

• SCN_CHARADDED事件记录最后输入的字符，在SCN_UPDATEUI事件中处理缩进。
• 当输入回车时(LastProcessedChar == ' ')，我们只需要保证新行和前一行的缩进相同就可以了。
• SCI_GETLINEINDENTATION命令可以取得指定行的缩进数（即行首的空格数目）。
• SCI_REPLACESEL命令用指定字符串替换选择区域
• SCI_GETCURRENTPOS命令取得当前位置
• SCI_GETCHARAT命令取得指定位置的字符
• SCI_LINEFROMPOSITION命令取得指定位置所在的行号
• SCI_POSITIONFROMLINE命令取得指定行号的起始位置
• SCI_WORDSTARTPOSITION命令取得指定位置所在单词的起始位置，如xxx|xx,（｜代表指定位置），那么它会返回|xxxxx的位置。同样还有SCI_WORDENDPOSITION命令。
• SCI_BRACEMATCH取得括号的另一半位置，如指定位置的字符是'}'时，它返回匹配的'{'所在的位置。
• SCI_SETTARGETSTART和SCI_SETTARGETEND设置TARGET的起始和始止位置，SCI_REPLACETARGET命令用指定字符串替换TARGET指定范围内的字符。

VS的代码完成和函数提示功能是很值得称道的，它们可以极大地提高我们的编程效率（造成我现在写代码时往往只记住前四个字母，如果在对象后面点了小数点后不出现提示就会心慌意乱的说-_-），尽管有时也会失效。

做为IDE这个功能是绝对不能少D。即使你只打算做个编辑器，如果有这个功能那也是一大亮点啊~~（目前很多代码编辑器都没这个功能的说）。

关于函数提示的几个命令以SCI_CALLTIP作为前缀，这里只介绍我们即将使用的几个命令（更多命令见:http://scintilla.sourceforge.net/ScintillaDoc.html#CallTips）

• SCI_CALLTIPSHOW(int posStart, const char *definition) 显示提示。posStart表示显示位置，definition是显示的内容
• SCI_CALLTIPCANCEL 取消提示
• SCI_CALLTIPACTIVE 如果当前编辑器中有提示信息，返回1，否则返回0
• SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd) 设置提示中的高亮位置，在VS里我们输入函数实参时函数提示会高亮当前输入的参数名。

在我们程序中加入提示的最佳时机是SCN_CHARADDED（见上一节）事件。当用户输入左圆括号'('时，取得括号左边的函数名，然后显示出该函数的完整定义。

下面的代码实现了CreateWindow和MoveWindow两个API的函数提示

?

//我们要高亮的两个函数 const  size_t  FUNCSIZE=2; char * g_szFuncList[FUNCSIZE]={ //函数名      "CreateWindow(" ,      "MoveWindow(" }; char * g_szFuncDesc[FUNCSIZE]={ //函数信息      "HWND CreateWindow("      "LPCTSTR lpClassName,"      " LPCTSTR lpWindowName,"      " DWORD dwStyle, "      " int x,"      " int y,"      " int nWidth,"      " int nHeight, "      " HWND hWndParent,"      " HMENU hMenu,"      " HANDLE hInstance,"      " PVOID lpParam"      ")" ,      "BOOL MoveWindow("      "HWND hWnd,"      " int X,"      " int Y,"      " int nWidth,"      " int nHeight,"      " BOOL bRepaint"      ")" }; 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_CHARADDED)          {              ...              // 函数提示功能              static  const  char * pCallTipNextWord = NULL; //下一个高亮位置              static  const  char * pCallTipCurDesc = NULL; //当前提示的函数信息              if (notify->ch == '(' ) //如果输入了左括号，显示函数提示              {                  char  word[1000]; //保存当前光标下的单词(函数名)                  TextRange tr;    //用于SCI_GETTEXTRANGE命令                  int  pos = SendEditor(SCI_GETCURRENTPOS); //取得当前位置（括号的位置）                  int  startpos = SendEditor(SCI_WORDSTARTPOSITION,pos-1); //当前单词起始位置                  int  endpos = SendEditor(SCI_WORDENDPOSITION,pos-1); //当前单词终止位置                  tr.chrg.cpMin = startpos;  //设定单词区间，取出单词                  tr.chrg.cpMax = endpos;                  tr.lpstrText = word;                  SendEditor(SCI_GETTEXTRANGE,0, sptr_t(&tr));                                     for ( size_t  i=0; i<FUNCSIZE; i++) //找找有没有我们认识的函数？                  {                      if ( memcmp (g_szFuncList[i],word, sizeof (g_szFuncList[i])) == 0)                      {     //找到啦，那么显示提示吧                          pCallTipCurDesc = g_szFuncDesc[i]; //当前提示的函数信息                          SendEditor(SCI_CALLTIPSHOW,pos,sptr_t(pCallTipCurDesc)); //显示这个提示                          const  char  *pStart = strchr (pCallTipCurDesc, '(' )+1; //高亮第一个参数                          const  char  *pEnd = strchr (pStart, ',' ); //参数列表以逗号分隔                          if (pEnd == NULL) pEnd = strchr (pStart, ')' ); //若是最后一个参数，后面是右括号                          SendEditor(SCI_CALLTIPSETHLT,                              pStart-pCallTipCurDesc, pEnd-pCallTipCurDesc);                          pCallTipNextWord = pEnd+1; //指向下一参数位置                          break ;                      }                  }              }              else  if (notify->ch == ')' ) //如果输入右括号，就关闭函数提示              {                  SendEditor(SCI_CALLTIPCANCEL);                  pCallTipCurDesc = NULL;                  pCallTipNextWord = NULL;                              }              else  if (notify->ch == ','  && SendEditor(SCI_CALLTIPACTIVE) && pCallTipCurDesc)              {                  //输入的是逗号，高亮下一个参数                  const  char  *pStart = pCallTipNextWord;                  const  char  *pEnd = strchr (pStart, ',' );                  if (pEnd == NULL) pEnd = strchr (pStart, ')' );                  if (pEnd == NULL) //没有下一个参数啦，关闭提示                      SendEditor(SCI_CALLTIPCANCEL);                  else                  {                      SendEditor(SCI_CALLTIPSETHLT,pStart-pCallTipCurDesc, pEnd-pCallTipCurDesc);                      pCallTipNextWord = pEnd+1;                  }              }          } //if(notify->nmhdr.code == SCN_CHARADDED)          ...      } //if(Message.Msg == WM_NOTIFY) }

当然，这个提示功能相当山寨啦。比如函数名和括号之间有空格提示就不出来了，函数嵌套调用时只会提示最后一个函数的参数。关于如果改进，大家各显神通吧。

另外，还有一个提外话，在实际的使用中，我们的函数信息不可能象这里一样是写死的，而是依据用户的输入动态生成的函数名及信息列表。这就涉及到一个C++代码解析的问题（还好，只要解析函数声明就行了），对于这一点，牛X的同学可以自己写解析代码；次牛X的可以考虑用WAVE,Spirit,Regex等库帮助解析；象偶这种不牛的同学，则可以考虑利用CTAGS工具在后台线程中生成tag文件，我们从tag文件里取就可以了（当然，效率嘛~~可以参考C++Builder的函数提示效率-_-）。

代码完成和函数提示的用法类似，前缀是SCI_AUTOC，具体命令见:http://scintilla.sourceforge.net/ScintillaDoc.html#Autocompletion

?

void  __fastcall TForm1::WndProc(Messages::TMessage &Message) {      TForm::WndProc(Message);      if (Message.Msg == WM_NOTIFY)      {          ...          if (notify->nmhdr.code == SCN_CHARADDED)          {              ...              if (notify->ch == '.' )              {                  char  word[1000]; //保存当前光标下的单词                  TextRange tr;    //用于SCI_GETTEXTRANGE命令                  int  pos = SendEditor(SCI_GETCURRENTPOS); //取得当前位置                  int  startpos = SendEditor(SCI_WORDSTARTPOSITION,pos-1); //当前单词起始位置                  int  endpos = SendEditor(SCI_WORDENDPOSITION,pos-1); //当前单词终止位置                  tr.chrg.cpMin = startpos;  //设定单词区间，取出单词                  tr.chrg.cpMax = endpos;                  tr.lpstrText = word;                  SendEditor(SCI_GETTEXTRANGE,0, sptr_t(&tr));                  if ( strcmp (word, "file." ) == 0) //输入file.后提示file对象的几个方法                  {                      SendEditor(SCI_AUTOCSHOW,0,                          sptr_t(                              "close "                              "eof "                              "good "                              "open "                              "rdbuf "                              "size"                          ));                  }              }              ...

SCI_AUTOCSHOW命令的第一个参数表示已经输入了多少个字符。这对于代码自动完成是很有帮助的，比如我们可以用它帮助用户输入长串的单词，如：

?

if ( strcmp (word, "Create" ) == 0) {      SendEditor(SCI_AUTOCSHOW,6, //已经输入了6位字符          sptr_t(              "CreateBitmap "              "CreateDC "              "CreateHandle "              "CreateWindow "              "CreateWindowEx"          )); }

支持中文

Scintilla默认用的是ANSI编码，所以编辑中文之类的多字节编码时，会出错半个字符的问题。我们可以使用SCI_SETCODEPAGE命令设置使用的编码。

为了支持多语言，建议使用UTF8编码：

1. // UTF-8编码
2. SendEditor(SCI_SETCODEPAGE,SC_CP_UTF8);