RichTextBox中的代码折叠

本文关键字:折叠 代码 RichTextBox | 更新日期: 2023-09-27 18:27:01

我正在使用C#开发从Winforms RichTextBox派生的代码编辑器。我已经实现了自动补全和语法hilighting,但代码折叠是一种不同的方法。我想要实现的是:

下面的代码:

public static SomeFunction(EventArgs e)
{
    //Some code
    //Some code
    //Some code
    //Some code
    //Some code
    //Some code
}

应该变成:

public static SomeFunction(EventArgs e)[...]

其中[...]是一个缩短的代码,当您将鼠标悬停在[...]上时,它会显示在工具提示中有什么想法或建议如何做到这一点,无论是使用Regex还是程序代码?

RichTextBox中的代码折叠

我创建了一个解析器,它将返回代码折叠位置的索引。

  • 折叠分隔符是由正则表达式定义的
  • 您可以指定开始和结束索引,这样在更新一个区域时就不必检查整个代码
  • 如果代码格式不正确,它将抛出异常,请随意更改该行为。一种替代方案可以是,它不断向上移动堆栈,直到找到合适的结束令牌

折叠查找器

public class FoldFinder
{
    public static FoldFinder Instance { get; private set; }
    static FoldFinder()
    {
        Instance = new FoldFinder();
    }
    public List<SectionPosition> Find(string code, List<SectionDelimiter> delimiters, int start = 0,
        int end = -1)
    {
        List<SectionPosition> positions = new List<SectionPosition>();
        Stack<SectionStackItem> stack = new Stack<SectionStackItem>();
        int regexGroupIndex;
        bool isStartToken;
        SectionDelimiter matchedDelimiter;
        SectionStackItem currentItem;
        Regex scanner = RegexifyDelimiters(delimiters);
        foreach (Match match in scanner.Matches(code, start))
        {
            // the pattern for every group is that 0 corresponds to SectionDelimter, 1 corresponds to Start
            // and 2, corresponds to End.
            regexGroupIndex = 
                match.Groups.Cast<Group>().Select((g, i) => new {
                    Success = g.Success,
                    Index = i
                })
                .Where(r => r.Success && r.Index > 0).First().Index;
            matchedDelimiter = delimiters[(regexGroupIndex - 1) / 3];
            isStartToken = match.Groups[regexGroupIndex + 1].Success;
            if (isStartToken)
            {
                stack.Push(new SectionStackItem()
                {
                    Delimter = matchedDelimiter,
                    Position = new SectionPosition() { Start = match.Index }
                });
            }
            else
            {
                currentItem = stack.Pop();
                if (currentItem.Delimter == matchedDelimiter)
                {
                    currentItem.Position.End = match.Index + match.Length;
                    positions.Add(currentItem.Position);
                    // if searching for an end, and we've passed it, and the stack is empty then quit.
                    if (end > -1 && currentItem.Position.End >= end && stack.Count == 0) break;
                }
                else
                {
                    throw new Exception(string.Format("Invalid Ending Token at {0}", match.Index)); 
                }
            }
        }
        if (stack.Count > 0) throw new Exception("Not enough closing symbols.");
        return positions;
    }
    public Regex RegexifyDelimiters(List<SectionDelimiter> delimiters)
    {
        return new Regex(
            string.Join("|", delimiters.Select(d =>
                string.Format("(({0})|({1}))", d.Start, d.End))));
    }
}
public class SectionStackItem
{
    public SectionPosition Position;
    public SectionDelimiter Delimter;
}
public class SectionPosition
{
    public int Start;
    public int End;
}
public class SectionDelimiter
{
    public string Start;
    public string End;
}

示例查找

下面的示例匹配由{,}[,]分隔的折叠,并且正好在符号之后直到;。我没有看到太多的IDE对每一行都进行折叠,但它在处理长代码时可能很方便,比如LINQ查询。

var sectionPositions = 
    FoldFinder.Instance.Find("abc { def { qrt; ghi [ abc ] } qrt }", new List<SectionDelimiter>(
        new SectionDelimiter[3] {
            new SectionDelimiter() { Start = "''{", End = "''}" },
            new SectionDelimiter() { Start = "''[", End = "'']" },
            new SectionDelimiter() { Start = "(?<=''[|''{|;|^)[^[{;]*(?=;)", End = ";" },
        }));