如何在 Windows 环境下使用 Scintilla 编辑控件?

http://www.scintilla.org/

http://scintilla.sourceforge.net/index.html

如何在 Windows 环境下使用 Scintilla 编辑控件?收藏

新一篇: scintilla 中的代码折叠功能的使用 | 旧一篇: 插件及可扩展性

请注意：此文翻译自http://scintilla.sourceforge.net/Steps.html。

Scintilla 控件可以在网站http://scintilla.sourceforge.net/index.html上获取。

如何在 Windows 环境下使用 Scintilla 编辑控件?
下面的将逐步介绍如何在 Windows 环境下使用 Scintilla 控件。

如何创建 Scintilla 编辑控件?
首先载入 Scintilla 控件的动态库，如下：
    hmod = LoadLibrary("SciLexer.DLL");
    if (hmod == NULL)
    {
        MessageBox(hwndParent,
                   "The Scintilla DLL could not be loaded.",
                   "Error loading Scintilla",
                   MB_OK | MB_ICONERROR);
    }

如果动态库成功载入，该动态库就已经为我们注册了一个新的 window class。
这个名称为 "Scintilla" 的新 window class 就是 Scintilla 编辑控件。

好了，我们已经可以像使用其他的windows控件一样来使用这个控件了：
    hwndScintilla = CreateWindowEx(0, "Scintilla", "", 
                    WS_CHILD | WS_VISIBLE | WS_TABSTOP | WS_CLIPCHILDREN,
                    10, 10, 500, 400, hwndParent, (HMENU)GuiID, hInstance, NULL);

请注意这个新的 window class 的名称是 "Scintilla"。到这里，我们实际上已经在我们的 windows 程序中引入了这个 Scintilla 控件。

怎样操作 Scintilla 控件呢？
简单地说，我们可以通过直接向 Scintilla 发送 commands 来操作该控件。有两种方式，一种方式使用起来比较简单而另外一种方式在执行速度上有优势。

操作 Scintilla 控件的简单的方法
这种方法和我们使用其他的 windows 控件没什么两样。我们可以发送消息给 Scintilla 控件，然后接受来自 Scintilla 控件的通知（notifications ）消息（请注意， Scintilla 控件是将这些通知消息都发送到其父窗体上）；

Scintilla 能够识别每一个 command，我们可以直接用 SendMessage 函数来向 Scintilla 控件发送消息：

    SendMessage(hwndScintilla, sci_command, wparam, lparam);
譬如：
    SendMessage(hwndScintilla, SCI_CREATEDOCUMENT, 0, 0);
 
有些 commands 是有返回值的，而另外一些命令的参数没有用到，这些参数需要设置成 NULL。

操作 Scintilla 控件的快速的方法
这里所说的快速调用的方法，其实就是在我们的代码中直接调用 Scintilla 编辑控件的消息处理函数。
Scintilla 为我们提供了一个消息处理函数，我们可以获取到这个消息处理函数，然后直接调用这个函数函数来执行相应的 commands。这种方式要比使用 SendMessage 发送消息的处理速度要快。

首先，我们可以通过 SCI_GETDIRECTFUNCTION 和 SCI_GETDIRECTPOINTER 这两个命令来获取到上面提到的消息处理函数和该函数所需要的第一个参数。获取这两个指针我们必须通过 SendMessage :)(译者注：新版本的Scintilla 已经在动态库中导出了相应的函数)

整个过程如下：

    int (*fn)(void*, int, int, int);
    void * ptr;
    int canundo;

    fn = (int (__cdecl *)(void *, int, int, int))SendMessage(
        hwndScintilla, SCI_GETDIRECTFUNCTION, 0, 0);
    ptr = (void *)SendMessage(hwndScintilla, SCI_GETDIRECTPOINTER, 0, 0);

    canundo = fn(ptr, SCI_CANUNDO,0,0);

上面的 "fn" 就是 Scintilla 控件的消息处理函数， "ptr" 就是我们每次调用消息处理函数必须用到的第一个参数。剩下的几个参数分别是 Scintilla 的 command(消息、命令) 和该 Command 的两个可选参数。

如何接受 Scintilla 的通知消息？
一旦某个事件触发了，而且 Scintilla 控件认为需要通知用户，它就会向该控件的父窗体发 WM_NOTITY 消息。 我们收到这个消息后需要根据该消息的实际数据结构进行处理。

我们可以在 Scintilla 的父窗体的消息处理函数中包含类似下面的代码：

    NMHDR *lpnmhdr;

    [...]

    case WM_NOTIFY:
        {
            lpnmhdr = (LPNMHDR) lParam;

            if(lpnmhdr->hwndFrom == hwndScintilla)
            {
                switch (lpnmhdr->code)
                {
                case SCN_CHARADDED:
                    {
                        /* Hey, Scintilla just told me that a new  */
                        /* character was added to the Edit Control.*/
                        /* Now i do something cool with that char. */
                    }break;
                }
            }
        }break;

 

Page contributed by Holger Schmidt.. libbyliugang translate it to chinese.:)

scintilla 中的代码折叠功能的使用收藏

 | 旧一篇:  如何在 Windows 环境下使用 Scintilla 编辑控件?

本文翻译自http://sphere.sourceforge.net/flik/docs/scintilla-folding.html

使用 scintilla 中的代码折叠功能
scintilla 是一个脚本编辑组件，您可以到 http://www.scintilla.org 这个网站上看看。

--------------------------------------------------------------------------------
下面介绍如何使用 scintilla 的代码折叠功能

--------------------------------------------------------------------------------

首先咋们来创建一些我们稍后会用到的一些常量。
static const int MARGIN_SCRIPT_FOLD_INDEX = 1;

为窗口注册 margin Event （即用户执行折叠和展开代码时，触发的事件）事件（仅用于 windows 环境）

static const int WINDOW_ID = 900;

BEGIN_MESSAGE_MAP(CDocumentWindow, CDocumentWindowsBaseClass)
  ON_NOTIFY(SCN_MARGINCLICK, WINDOW_ID, OnMarginClicked)
END_MESSAGE_MAP()

（这里的 WINDOW_ID 就是我们调用 CreateWindow 创建窗口时经常用到的）

设置我们需要的 lexer(词法识别器，用于识别代码格式)...
(可以直接使用已有的常量，也可以自己手动创建...)

  SendEditor(SCI_SETLEXER, SCLEX_CPP);
  SendEditor(SCI_SETSTYLEBITS, 5);

设置我们用到的 lexer 的一些属性

  SendEditor(SCI_SETPROPERTY, (WPARAM)"fold", (LPARAM)"1");
  SendEditor(SCI_SETPROPERTY, (WPARAM)"fold.compact", (LPARAM)"0");

（这里的 fold.compact 选项就是折叠必要的代码行；我不太喜欢这个特性，但是这个属性缺省值就是"1"）
下面这样也不错：

  SendEditor(SCI_SETPROPERTY, (WPARAM)"fold.comment", (LPARAM)"1");
  SendEditor(SCI_SETPROPERTY, (WPARAM)"fold.preprocessor", (LPARAM)"1");

现在让我们将所有的 margins 重置
（可以通过 RecalcLineMargin 函数处理...）

  SendEditor(SCI_SETMARGINWIDTHN, MARGIN_SCRIPT_FOLD_INDEX, 0);

接着，设置 margin 类型和 margin 掩码（mask），并重置...

  SendEditor(SCI_SETMARGINTYPEN,  MARGIN_SCRIPT_FOLD_INDEX, SC_MARGIN_SYMBOL);
  SendEditor(SCI_SETMARGINMASKN, MARGIN_SCRIPT_FOLD_INDEX, SC_MASK_FOLDERS);
  SendEditor(SCI_SETMARGINWIDTHN, MARGIN_SCRIPT_FOLD_INDEX, 20);

设置一些其他的选项

  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDER, SC_MARK_PLUS);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPEN, SC_MARK_MINUS);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEREND, SC_MARK_EMPTY);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERMIDTAIL, SC_MARK_EMPTY);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDEROPENMID, SC_MARK_EMPTY);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERSUB, SC_MARK_EMPTY);
  SendEditor(SCI_MARKERDEFINE, SC_MARKNUM_FOLDERTAIL, SC_MARK_EMPTY);

  SendEditor(SCI_SETFOLDFLAGS, 16, 0); // 16   如果没有展开就在折叠行的下面划一条横线

我们注册一下通知事件，这样当用户点击 margin 时，scintilla 就会通知我们。

  SendEditor(SCI_SETMARGINSENSITIVEN, MARGIN_SCRIPT_FOLD_INDEX, 1);

响应 SCN_MARGINCLICK 事件...(请注意函数原型)

afx_msg void
CDocumentWindow::OnMarginClick(NMHDR* nmhdr, LRESULT* result)
{
  SCNotification* notify = (SCNotification*)nmhdr;

  const int modifiers = notify->modifiers;
  const int position = notify->position;
  const int margin = notify->margin;
  const int line_number = SendEditor(SCI_LINEFROMPOSITION, position, 0);

  switch (margin)
  {
    case MARGIN_SCRIPT_FOLD_INDEX:
    {
      SendEditor(SCI_TOGGLEFOLD, line_number, 0);
    }break;
  }
}

有了上面这些应该能够工作了。
You'll want to play around with it until you're happy with the way the folding works,
scintilla seems to use a much more complicated MarginClick...
Luckily harvesting the MarginClick code from scintilla is easy:

首先修改一下 OnMarginClick:

      SendEditor(SCI_TOGGLEFOLD, line_number, 0);

修改为: 
      MarginClick(position, modifiers);

接着在你的头文件中...
Then in your header file...

  bool MarginClick(int position, int modifiers);
  void Expand(int &line, bool doExpand,
              bool force = false, int visLevels = 0, int level = -1);
  void FoldAll();

接着到 SciTEBase.cxx 中找一些你需要的代码，直接粘贴到你自己的文件中（译者注：没想到作者要我这样写代码:)）

对了，你最好赶快更新一下你的 Goto Line 函数...(译者：跳转到某一行功能，可能是这里比较容易出错)

 SendEditor(SCI_ENSUREVISIBLEENFORCEPOLICY, line_number);
 SendEditor(SCI_GOTOLINE, line_number);

就这些了，enjoy.

如果对此有什么问题或者建议你可以发邮件到 [e-mail]

 libbyliugang translate to chinese.

 

发表于 @ 2007年12月17日 17:59:00|评论(0)|编辑

 | 旧一篇:  如何在 Windows 环境下使用 Scintilla 编辑控件?