VS Extension:TextPoint.GreaterThan/LessThan对于大文件来说非常慢

Question

我正在开发一个VS扩展,需要知道文本光标当前位于哪个类成员(方法,属性等).它还需要父母的意识(例如,类,嵌套类等).它需要知道成员或类的类型,名称和行号.当我说"类型"时我的意思是"方法"或"属性"不一定是".NET类型".

目前我在这里使用此代码:

public static class CodeElementHelper
{
    public static CodeElement[] GetCodeElementAtCursor(DTE2 dte)
    {
        try
        {
            var cursorTextPoint = GetCursorTextPoint(dte);

            if (cursorTextPoint != null)
            {
                var activeDocument = dte.ActiveDocument;
                var projectItem = activeDocument.ProjectItem;
                var codeElements = projectItem.FileCodeModel.CodeElements;
                return GetCodeElementAtTextPoint(codeElements, cursorTextPoint).ToArray();
            }
        }
        catch (Exception ex)
        {
            Debug.WriteLine("[DBG][EXC] - " + ex.Message + " " + ex.StackTrace);
        }

        return null;
    }

    private static TextPoint GetCursorTextPoint(DTE2 dte)
    {
        var cursorTextPoint = default(TextPoint);

        try
        {
            var objTextDocument = (TextDocument)dte.ActiveDocument.Object();
            cursorTextPoint = objTextDocument.Selection.ActivePoint;
        }
        catch (Exception ex)
        {
            Debug.WriteLine("[DBG][EXC] - " + ex.Message + " " + ex.StackTrace);
        }

        return cursorTextPoint;
    }

    private static List<CodeElement> GetCodeElementAtTextPoint(CodeElements codeElements, TextPoint objTextPoint)
    {
        var returnValue = new List<CodeElement>();

        if (codeElements == null)
            return null;

        int count = 0;
        foreach (CodeElement element in codeElements)
        {
            if (element.StartPoint.GreaterThan(objTextPoint))
            {
                // The code element starts beyond the point
            }
            else if (element.EndPoint.LessThan(objTextPoint))
            {
                // The code element ends before the point
            }
            else
            {
                if (element.Kind == vsCMElement.vsCMElementClass ||
                    element.Kind == vsCMElement.vsCMElementProperty ||
                    element.Kind == vsCMElement.vsCMElementPropertySetStmt ||
                    element.Kind == vsCMElement.vsCMElementFunction)
                {
                    returnValue.Add(element);
                }

                var memberElements = GetCodeElementMembers(element);
                var objMemberCodeElement = GetCodeElementAtTextPoint(memberElements, objTextPoint);

                if (objMemberCodeElement != null)
                {
                    returnValue.AddRange(objMemberCodeElement);
                }

                break;
            }
        }

        return returnValue;
    }

    private static CodeElements GetCodeElementMembers(CodeElement codeElement)
    {
        CodeElements codeElements = null;

        if (codeElement is CodeNamespace)
        {
            codeElements = (codeElement as CodeNamespace).Members;
        }
        else if (codeElement is CodeType)
        {
            codeElements = (codeElement as CodeType).Members;
        }
        else if (codeElement is CodeFunction)
        {
            codeElements = (codeElement as CodeFunction).Parameters;
        }

        return codeElements;
    }
}

所以当前有效,如果我调用GetCodeElementAtCursor,我将获得该成员,并且它的父母会回来.(这是一个古老的代码,但我相信我最初从Carlos的博客中获取它并从VB移植它).

我的问题是,当我的扩展用于非常大的代码时,例如自动生成的文件有几千行,例如,它会带来VS爬行.几乎无法使用.运行探查器显示热线是

private static List<CodeElement> GetCodeElementAtTextPoint(CodeElements codeElements, TextPoint objTextPoint)
{
    foreach (CodeElement element in codeElements)
    {
        ...
/*-->*/ if (element.StartPoint.GreaterThan(objTextPoint)) // HERE <---
        {
            // The code element starts beyond the point
        }
/*-->*/ else if (element.EndPoint.LessThan(objTextPoint)) // HERE <----
        {
            // The code element ends before the point
        }
        else
        {
            ...
            var memberElements = GetCodeElementMembers(element);
/*-->*/     var objMemberCodeElement = GetCodeElementAtTextPoint(memberElements, objTextPoint); // AND, HERE <---

            ...
        }
    }

    return returnValue;
}

所以第三个是显而易见的,它是对自身的递归调用,因此影响它的任何因素都会影响对自身的调用.然而,前两个,我不知道如何解决.

• 是否有一种替代方法可以用来检索我的光标所在的成员类型(类,方法,道具等),名称,行号和父母？
• 有什么我可以做,使TextPoint.GreaterThan和TestPoint.LessThan方法有更好的表现？
• 或者,我是SOL吗？

无论方法是什么,它只需要支持VS2015或更新版本.

谢谢!

更新:回答谢尔盖的评论 - 它确实似乎是由.GreaterThan/ 引起的.LessThan().我已经分开的代码和放缓的那些方法调用,而不是属性访问器的绝对发生element.StartPoint和element.EndPoint.

Answer 1

我最终选择了使用一些新的 roslyn 东西。下面的代码（几乎）与我在问题中上面的代码执行的所有操作相同，此外还返回了 Moniker。

我将此标记为答案，但由于 Sergey 在他的答案中非常有帮助，加上我的 Roslyn 代码的灵感实际上来自这个 SO 答案，这也是他的答案，他绝对值得得分:)。

代码

public static (string, ImageMoniker)[] GetSyntaxHierarchyAtCaret(IWpfTextView textView)
{
    var caretPosition =
        textView.Caret.Position.BufferPosition;

    var document =
        caretPosition.Snapshot.GetOpenDocumentInCurrentContextWithChanges();

    var syntaxRoot =
        document.GetSyntaxRootAsync().Result;

    var caretParent =
        syntaxRoot.FindToken(caretPosition).Parent;

    var returnValue = new List<(string, ImageMoniker)>();
    while (caretParent != null)
    {
        var kind = caretParent.Kind();

        switch (kind)
        {
            case SyntaxKind.ClassDeclaration:
                {
                    var dec = caretParent as ClassDeclarationSyntax;
                    returnValue.Add((dec.Identifier.ToString(),KnownMonikers.Class));
                    break;
                }
            case SyntaxKind.MethodDeclaration:
                {
                    var dec = caretParent as MethodDeclarationSyntax;
                    returnValue.Add((dec.Identifier.ToString(),KnownMonikers.Method));
                    break;
                }
            case SyntaxKind.PropertyDeclaration:
                {
                    var dec = caretParent as PropertyDeclarationSyntax;
                    returnValue.Add((dec.Identifier.ToString(), KnownMonikers.Property));
                    break;
                }
        }

        caretParent = caretParent.Parent;
    }

    return returnValue.ToArray();
}

依赖关系

由于我要返回一个元组，因此您将需要System.ValueTuple，而 Roslyn 的东西需要Microsoft.CodeAnalysis.EditorFeatures.Text、Microsoft.CodeAnalysis.CSharp以及所有依赖项。

VS2015/2017 的目标版本和所需的 .NET 版本

CodeAnalysis 程序集要求您以（我认为）.NET 4.6.1 或更高版本为目标。CodeAnalysis 程序集的版本也直接关系到它可以支持的 VS 版本。我还没有看到任何关于此的官方文档（我认为应该在每个 msdn 页面的顶部以粗体红色字母发布有关此内容的文档！），但这里有一个 SO 答案，其中包含用于不同 VS 目标的版本。您最早可以瞄准的目标似乎是 VS2015 (RTM)。我个人使用的是 v1.3.2，它应该支持 VS2015 Update 3 或更高版本。

表现

我没有通过分析器运行它，但它运行得相当流畅。首先，在大文件上，它不起作用（我假设该文件正在被索引），但如果您仔细观察，VS 中的许多功能在索引（或无论是什么）都已完成。你很难注意到它。对于小文件来说，这是微不足道的。

（与问题稍微无关，但可能对某人有帮助......）

对于任何使用 CaretChanged 事件来驱动此类功能但遇到性能问题的人来说，有一个提示：我建议使用调度程序并限制调用数量。下面的代码将为调用添加 200 毫秒的延迟，并且每 200 毫秒不允许调用一次以上。嗯，至少 200 毫秒。它是不可预测的，但它会在能够时以低优先级运行（DispatcherPriority.ApplicationIdle）：

private readonly IWpfTextView _textView;
private readonly DispatcherTimer _throttleCursorMove;

...

// constructor
{
    _textView.Caret.PositionChanged += HandleCaretPositionChanged;

    _throttleCursorMove = new DispatcherTimer(DispatcherPriority.ApplicationIdle);
    _throttleCursorMove.Tick += (sender, args) => CaretPositionChanged();
    _throttleCursorMove.Interval = new TimeSpan(0, 0, 0, 0, 200);
}

private void HandleCaretPositionChanged(object sender, CaretPositionChangedEventArgs e)
{
    if (!_throttleCursorMove.IsEnabled)
        _throttleCursorMove.Start();
}

private void CaretPositionChanged()
{
    _throttleCursorMove.Stop();
    ...
    var hierarchy = CodeHierarchyHelper.GetSyntaxHierarchyAtCaret(_textView);
    ...
}

...