AvalonEdit C#代码折叠策略类

最新推荐文章于 2025-02-22 08:01:33 发布

jxlzw

最新推荐文章于 2025-02-22 08:01:33 发布

阅读量3.2k

点赞数

分类专栏： C# WPF 文章标签： visual studio code

本文链接：https://blog.csdn.net/jxlzw/article/details/111942008

版权

C# 同时被 2 个专栏收录

2 篇文章

订阅专栏

WPF

1 篇文章

订阅专栏

背景

AvalonEdit是一个基于WPF的开源、可扩展文本编辑器，用于代码的编辑显示，还可实现语法高亮、代码折叠、自动补全等功能，在需要显示或编辑代码的应用程序中确是一个不错的选择。然美中不足的是这些功能多数还需要用户自己扩展。以代码折叠为例，类库中仅提供了Xml文档的折叠功能，其它语言的代码折叠尚需用户自己实现。所幸的是在其示例代码中提供了一个BraceFoldingStrategy类，实现了代码基于花括号{、}的折叠，为我们扩展其它内容的折叠提供了有益的借鉴。本文根据BraceFoldingStrategy的思路，增加了C#代码的using块、region块和注释块的折叠功能。

基本思路

BraceFoldingStrategy的思路是逐字符扫描文档字符，遇到“{”，将其位置压入堆栈（starts），遇到“}”，如果starts不为空，弹出一个作为NewFolding的开始位置，将“}”所在位置的下一个字符位置作为结束位置，构造NewFolding对象。
鉴于我们所要增加的折叠，其开始、结束标志并非单个字符，而是一个字符串，所以我们还是用正则表达式匹配的办法来寻找开始、结束位置。我们的思路是将文档文本分割成文本行（自定义类TextLine对象，TextLine类代码详见完整代码），再逐行匹配开始、结束标志，开始标志匹配成功，将开始位置压入堆栈（starts），结束标志匹配成功，如果starts不为空，弹出一个作为开始位置，再将结束标志最后一个字符的下一个字符位置作为结束位置，构造NewFolding对象，添加到NewFloding列表之中。

代码示例

1. using块的折叠

private NewFolding UsingFolding(List<TextLine> lines)
{	
	int start = -1;
    for (int i = 0; i < lines.Count; i++)
    {
        TextLine line = lines[i];
        if (Regex.Match(line.Text, "using").Success)
        {
            if (start < 0) start = line.Offset;
        }
        else
        {
            if (start >= 0)
            {
                NewFolding fold = new NewFolding(start, line.Offset);
                fold.Name = "using";
                fold.DefaultClosed = true;
                return fold;
            }
        }
    }
    return null;
}

C#代码的using块一般都集中在一起，所以这里只返回一个NewFolding对象，是将找到的第一个“using”字符串的首字母位置作为开始位置，直到找到某一行中没有“using’字符串时，将这一行的开始位置作为折叠的结束位置，构造NewFolding对象并返回。当然这里隐含的一个条件是using块中没有空行，如果有空行，空行以后的using语句将被排除在外。如要避免这种情况，还得稍加处理。

2. 注释块的折叠

单行注释没有折叠的必要，所以这里针对的是多行注释（注释块）。

private List<NewFolding> NoteFoldings(List<TextLine> lines)
{
    List<NewFolding> folds = new List<NewFolding>();
    Stack<int> starts = new Stack<int>();
    Stack<string> names = new Stack<string>();
    int startLine = -1;
    for (int i = 0; i < lines.Count; i++)
    {
        TextLine line = lines[i];
        Match m = Regex.Match(line.Text, "/{2,}(\\s.+)$", RegexOptions.Multiline);
        if (m.Success)
        {
            if (startLine < 0)
            {
                starts.Push(line.Offset + m.Index);
                names.Push(m.Groups[1].Value);
                startLine = i;
            }
        }
        else if(starts.Count>0)
        {
            int start = starts.Pop();
            string name = names.Pop();
            if (i - startLine > 1)
            {
                m = Regex.Match(line.Text, "^\\s*", RegexOptions.Multiline);
                NewFolding fold = new NewFolding(start, line.Offset + (m.Success ? m.Length : 4));
                fold.Name =  "…";
                fold.DefaultClosed = true;
                folds.Add(fold);
                startLine = -1;
            }
        }
    }
    return folds;
}

注释块的开始标志是2个及以上的斜杠“/”，代码中的变量startLine（表示注释开始行），有两个作用，一是标志注释块有没有开始，当startLine<0时匹配到开始标志，将当前行号赋值给startLine，意味着注释块开始，随后再匹配到开始标志，则意味着在注释块内部，忽略之。二是判断是单行注释还是多行注释。当开始标志在某行中匹配失败时，意味着当前行不是注释行，将当前行号与startLine比较，看其差是否大于1，若是说明是多行注释，需要折叠，构造NewFolding对象，否则忽略。

3. region块的折叠

private List<NewFolding> RegionFoldings(List<TextLine> lines)
{
    List<NewFolding> folds = new List<NewFolding>();
    Stack<int> starts = new Stack<int>();
    Stack<string> names = new Stack<string>();            
    for (int i = 0; i < lines.Count; i++)
    {
        TextLine line = lines[i];
        Match m=Regex.Match(line.Text, "#region(\\s.+)$", RegexOptions.Multiline);
        if (m.Success)
        {
            starts.Push(line.Offset + m.Index);
            names.Push(m.Groups[1].Value);
        }
        m = Regex.Match(line.Text, "^\\s*#endregion", RegexOptions.Multiline);
        if (m.Success && starts.Count > 0)
        {
            int start=starts.Pop();
            NewFolding fold = new NewFolding(start, line.Offset + m.Length);
            fold.Name = names.Pop();
            fold.DefaultClosed = true;
            folds.Add(fold);
        }
    }
    return folds;
}