src/Workspaces/SharedUtilitiesAndExtensions/Compiler/CSharp/Extensions/SyntaxTreeExtensions.cs - main - githubmirror/roslyn

src/Workspaces/SharedUtilitiesAndExtensions/Compiler/CSharp/Extensions/SyntaxTreeExtensions.cs
560 строк21 KB
Cyrus Najmabadi
Fix speeling
21 мар 2025, 23:03
21 мар 2025, 23:0353105cf
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Shared.Extensions;
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis.CSharp.Extensions;

internal static partial class SyntaxTreeExtensions
{
    public static ISet<SyntaxKind> GetPrecedingModifiers(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
        => syntaxTree.GetPrecedingModifiers(position, cancellationToken, out _);

    public static ISet<SyntaxKind> GetPrecedingModifiers(
        this SyntaxTree syntaxTree,
        int position,
        CancellationToken cancellationToken,
        out int positionBeforeModifiers)
    {
        positionBeforeModifiers = position;
        var tokenOnLeftOfPosition = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);
        var token = tokenOnLeftOfPosition.GetPreviousTokenIfTouchingWord(position);

        var result = new HashSet<SyntaxKind>(SyntaxFacts.EqualityComparer);
        while (token.IsPotentialModifier(out var modifierKind))
        {
            result.Add(modifierKind);
            positionBeforeModifiers = token.FullSpan.Start;
            token = token.GetPreviousToken(includeSkipped: true);
        }

        return result;
    }

    public static TypeDeclarationSyntax? GetContainingTypeDeclaration(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        return syntaxTree.GetContainingTypeDeclarations(position, cancellationToken).FirstOrDefault();
    }

    public static BaseTypeDeclarationSyntax? GetContainingTypeOrEnumDeclaration(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        return syntaxTree.GetContainingTypeOrEnumDeclarations(position, cancellationToken).FirstOrDefault();
    }

    public static IEnumerable<TypeDeclarationSyntax> GetContainingTypeDeclarations(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);

        return token.GetAncestors<TypeDeclarationSyntax>().Where(t =>
        {
            return BaseTypeDeclarationContainsPosition(t, position);
        });
    }

    private static bool BaseTypeDeclarationContainsPosition(BaseTypeDeclarationSyntax declaration, int position)
    {
        if (position <= declaration.OpenBraceToken.SpanStart)
        {
            return false;
        }

        if (declaration.CloseBraceToken.IsMissing)
        {
            return true;
        }

        return position <= declaration.CloseBraceToken.SpanStart;
    }

    public static IEnumerable<BaseTypeDeclarationSyntax> GetContainingTypeOrEnumDeclarations(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);

        return token.GetAncestors<BaseTypeDeclarationSyntax>().Where(t => BaseTypeDeclarationContainsPosition(t, position));
    }

    private static readonly Func<SyntaxKind, bool> s_isDot = k => k is SyntaxKind.DotToken;
    private static readonly Func<SyntaxKind, bool> s_isDotOrArrow = k => k is SyntaxKind.DotToken or SyntaxKind.MinusGreaterThanToken;
    private static readonly Func<SyntaxKind, bool> s_isDotOrArrowOrColonColon =
        k => k is SyntaxKind.DotToken or SyntaxKind.MinusGreaterThanToken or SyntaxKind.ColonColonToken;

    public static bool IsRightOfDotOrArrowOrColonColon(this SyntaxTree syntaxTree, int position, SyntaxToken targetToken, CancellationToken cancellationToken)
    {
        return
            (targetToken.IsKind(SyntaxKind.DotDotToken) && position == targetToken.SpanStart + 1) ||
            syntaxTree.IsRightOf(position, s_isDotOrArrowOrColonColon, cancellationToken);
    }

    public static bool IsRightOfDotOrArrow(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
        => syntaxTree.IsRightOf(position, s_isDotOrArrow, cancellationToken);

    public static bool IsRightOfDot(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
        => syntaxTree.IsRightOf(position, s_isDot, cancellationToken);

    private static bool IsRightOf(
        this SyntaxTree syntaxTree, int position, Func<SyntaxKind, bool> predicate, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);
        token = token.GetPreviousTokenIfTouchingWord(position);

        if (token.Kind() == SyntaxKind.None)
        {
            return false;
        }

        return predicate(token.Kind());
    }

    public static bool IsRightOfNumericLiteral(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);
        return token.Kind() == SyntaxKind.NumericLiteralToken;
    }

    public static bool IsAfterKeyword(this SyntaxTree syntaxTree, int position, SyntaxKind kind, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken);
        token = token.GetPreviousTokenIfTouchingWord(position);

        return token.Kind() == kind;
    }

    public static bool IsEntirelyWithinNonUserCodeComment(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var inNonUserSingleLineDocComment =
            syntaxTree.IsEntirelyWithinSingleLineDocComment(position, cancellationToken) && !syntaxTree.IsEntirelyWithinCrefSyntax(position, cancellationToken);
        return
            syntaxTree.IsEntirelyWithinTopLevelSingleLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinPreProcessorSingleLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinMultiLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinMultiLineDocComment(position, cancellationToken) ||
            inNonUserSingleLineDocComment;
    }

    public static bool IsEntirelyWithinComment(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        return
            syntaxTree.IsEntirelyWithinTopLevelSingleLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinPreProcessorSingleLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinMultiLineComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinMultiLineDocComment(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinSingleLineDocComment(position, cancellationToken);
    }

    public static bool IsCrefContext(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken, includeDocumentationComments: true);
        token = token.GetPreviousTokenIfTouchingWord(position);

        if (token.Parent is XmlCrefAttributeSyntax attribute)
        {
            return token == attribute.StartQuoteToken;
        }

        return false;
    }

    public static bool IsEntirelyWithinCrefSyntax(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        if (syntaxTree.IsCrefContext(position, cancellationToken))
        {
            return true;
        }

        var token = syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken, includeDocumentationComments: true);
        return token.GetAncestor<CrefSyntax>() != null;
    }

    public static bool IsEntirelyWithinSingleLineDocComment(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var root = (CompilationUnitSyntax)syntaxTree.GetRoot(cancellationToken);
        var trivia = root.FindTrivia(position);

        // If we ask right at the end of the file, we'll get back nothing.
        // So move back in that case and ask again.
        var eofPosition = root.FullWidth();
        if (position == eofPosition)
        {
            var eof = root.EndOfFileToken;
            if (eof.HasLeadingTrivia)
            {
                trivia = eof.LeadingTrivia.Last();
            }
        }

        if (trivia.IsSingleLineDocComment())
        {
            RoslynDebug.Assert(trivia.HasStructure);

            var fullSpan = trivia.FullSpan;
            var endsWithNewLine = trivia.GetStructure()!.GetLastToken(includeSkipped: true).Kind() == SyntaxKind.XmlTextLiteralNewLineToken;

            if (endsWithNewLine)
            {
                if (position > fullSpan.Start && position < fullSpan.End)
                {
                    return true;
                }
            }
            else
            {
                if (position > fullSpan.Start && position <= fullSpan.End)
                {
                    return true;
                }
            }
        }

        return false;
    }

    public static bool IsEntirelyWithinMultiLineDocComment(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var trivia = syntaxTree.GetRoot(cancellationToken).FindTrivia(position);

        if (trivia.IsMultiLineDocComment())
        {
            var span = trivia.FullSpan;

            if (position > span.Start && position < span.End)
            {
                return true;
            }
        }

        return false;
    }

    public static bool IsEntirelyWithinMultiLineComment(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var trivia = syntaxTree.FindTriviaAndAdjustForEndOfFile(position, cancellationToken);

        if (trivia.IsMultiLineComment())
        {
            var span = trivia.FullSpan;

            return trivia.IsCompleteMultiLineComment()
                ? position > span.Start && position < span.End
                : position > span.Start && position <= span.End;
        }

        return false;
    }

    public static bool IsEntirelyWithinConflictMarker(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var trivia = syntaxTree.FindTriviaAndAdjustForEndOfFile(position, cancellationToken);

        if (trivia.Kind() == SyntaxKind.EndOfLineTrivia)
        {
            // Check if we're on the newline right at the end of a comment
            trivia = trivia.GetPreviousTrivia(syntaxTree, cancellationToken);
        }

        return trivia.Kind() == SyntaxKind.ConflictMarkerTrivia;
    }

    public static bool IsEntirelyWithinTopLevelSingleLineComment(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var trivia = syntaxTree.FindTriviaAndAdjustForEndOfFile(position, cancellationToken);

        if (trivia.Kind() == SyntaxKind.EndOfLineTrivia)
        {
            // Check if we're on the newline right at the end of a comment
            trivia = trivia.GetPreviousTrivia(syntaxTree, cancellationToken);
        }

        if (trivia.IsSingleLineComment() || trivia.IsShebangDirective())
        {
            var span = trivia.FullSpan;

            if (position > span.Start && position <= span.End)
            {
                return true;
            }
        }

        return false;
    }

    public static bool IsEntirelyWithinPreProcessorSingleLineComment(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        // Search inside trivia for directives to ensure that we recognize
        // single-line comments at the end of preprocessor directives.
        var trivia = syntaxTree.FindTriviaAndAdjustForEndOfFile(position, cancellationToken, findInsideTrivia: true);

        if (trivia.Kind() == SyntaxKind.EndOfLineTrivia)
        {
            // Check if we're on the newline right at the end of a comment
            trivia = trivia.GetPreviousTrivia(syntaxTree, cancellationToken, findInsideTrivia: true);
        }

        if (trivia.IsSingleLineComment())
        {
            var span = trivia.FullSpan;

            if (position > span.Start && position <= span.End)
            {
                return true;
            }
        }

        return false;
    }

    private static bool AtEndOfIncompleteStringOrCharLiteral(SyntaxToken token, int position, char lastChar, CancellationToken cancellationToken)
    {
        var kind = token.Kind();
        if (kind is not (
                SyntaxKind.StringLiteralToken or
                SyntaxKind.CharacterLiteralToken or
                SyntaxKind.SingleLineRawStringLiteralToken or
                SyntaxKind.MultiLineRawStringLiteralToken or
                SyntaxKind.Utf8StringLiteralToken or
                SyntaxKind.Utf8SingleLineRawStringLiteralToken or
                SyntaxKind.Utf8MultiLineRawStringLiteralToken))
        {
            throw new ArgumentException(CSharpCompilerExtensionsResources.Expected_string_or_char_literal, nameof(token));
        }

        // A UTF8 string literal must end with `"u8` and is thus never incomplete.
        if (kind is
                SyntaxKind.Utf8StringLiteralToken or
                SyntaxKind.Utf8SingleLineRawStringLiteralToken or
                SyntaxKind.Utf8MultiLineRawStringLiteralToken)
        {
            return false;
        }

        if (position != token.Span.End)
            return false;

        if (kind is SyntaxKind.SingleLineRawStringLiteralToken or SyntaxKind.MultiLineRawStringLiteralToken)
        {
            var sourceText = token.SyntaxTree!.GetText(cancellationToken);
            var startDelimiterLength = 0;
            var endDelimiterLength = 0;
            for (int i = token.SpanStart, n = token.Span.End; i < n; i++)
            {
                if (sourceText[i] != '"')
                    break;

                startDelimiterLength++;
            }

            for (int i = token.Span.End - 1, n = token.Span.Start; i >= n; i--)
            {
                if (sourceText[i] != '"')
                    break;

                endDelimiterLength++;
            }

            return token.Span.Length == startDelimiterLength ||
                (token.Span.Length > startDelimiterLength && endDelimiterLength < startDelimiterLength);
        }
        else
        {
            var startDelimiterLength = token.IsVerbatimStringLiteral() ? 2 : 1;
            return token.Span.Length == startDelimiterLength ||
                (token.Span.Length > startDelimiterLength && token.Text[^1] != lastChar);
        }
    }

    public static bool IsEntirelyWithinStringOrCharLiteral(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        return
            syntaxTree.IsEntirelyWithinStringLiteral(position, cancellationToken) ||
            syntaxTree.IsEntirelyWithinCharLiteral(position, cancellationToken);
    }

    public static bool IsEntirelyWithinStringLiteral(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
        => IsEntirelyWithinStringLiteral(syntaxTree, position, out _, cancellationToken);

    public static bool IsEntirelyWithinStringLiteral(
        this SyntaxTree syntaxTree, int position, out SyntaxToken stringLiteral, CancellationToken cancellationToken)
    {
        var token = syntaxTree.GetRoot(cancellationToken).FindToken(position, findInsideTrivia: true);

        // If we ask right at the end of the file, we'll get back nothing. We handle that case
        // specially for now, though SyntaxTree.FindToken should work at the end of a file.
        if (token.Kind() is SyntaxKind.EndOfDirectiveToken or SyntaxKind.EndOfFileToken)
            token = token.GetPreviousToken(includeSkipped: true, includeDirectives: true);

        stringLiteral = token;
        if (token.Kind() is
                SyntaxKind.StringLiteralToken or
                SyntaxKind.SingleLineRawStringLiteralToken or
                SyntaxKind.MultiLineRawStringLiteralToken or
                SyntaxKind.Utf8StringLiteralToken or
                SyntaxKind.Utf8SingleLineRawStringLiteralToken or
                SyntaxKind.Utf8MultiLineRawStringLiteralToken)
        {
            var span = token.Span;

            // cases:
            // "|"
            // "|  (e.g. incomplete string literal)
            return (position > span.Start && position < span.End)
                || AtEndOfIncompleteStringOrCharLiteral(token, position, '"', cancellationToken);
        }

        if (token.Kind() is
                SyntaxKind.InterpolatedStringStartToken or
                SyntaxKind.InterpolatedStringEndToken or
                SyntaxKind.InterpolatedRawStringEndToken or
                SyntaxKind.InterpolatedSingleLineRawStringStartToken or
                SyntaxKind.InterpolatedMultiLineRawStringStartToken)
        {
            return token.SpanStart < position && token.Span.End > position;
        }

        if (token.Kind() is SyntaxKind.InterpolatedStringTextToken)
        {
            // A interpolated text token is special in that it has no start/end delimiters itself.  So we just want
            // to know if we're touching it's span (as opposed to the above check which forces the position to be 
            // strictly within).
            return token.Span.Contains(position);
        }

        return false;
    }

    public static bool IsEntirelyWithinCharLiteral(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        var root = (CompilationUnitSyntax)syntaxTree.GetRoot(cancellationToken);
        var token = root.FindToken(position, findInsideTrivia: true);

        // If we ask right at the end of the file, we'll get back nothing.
        // We handle that case specially for now, though SyntaxTree.FindToken should
        // work at the end of a file.
        if (position == root.FullWidth())
        {
            token = root.EndOfFileToken.GetPreviousToken(includeSkipped: true, includeDirectives: true);
        }

        if (token.Kind() == SyntaxKind.CharacterLiteralToken)
        {
            var span = token.Span;

            // cases:
            // '|'
            // '|  (e.g. incomplete char literal)
            return (position > span.Start && position < span.End)
                || AtEndOfIncompleteStringOrCharLiteral(token, position, '\'', cancellationToken);
        }

        return false;
    }

    public static bool IsInInactiveRegion(
        this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        Contract.ThrowIfNull(syntaxTree);

        // cases:
        // $ is EOF

        // #if false
        //    |

        // #if false
        //    |$

        // #if false
        // |

        // #if false
        // |$

        if (syntaxTree.IsPreProcessorKeywordContext(position, cancellationToken))
        {
            return false;
        }

        // The latter two are the hard cases we don't actually have an 
        // DisabledTextTrivia yet. 
        var trivia = syntaxTree.GetRoot(cancellationToken).FindTrivia(position, findInsideTrivia: false);
        if (trivia.Kind() == SyntaxKind.DisabledTextTrivia)
        {
            return true;
        }

        var token = syntaxTree.FindTokenOrEndToken(position, cancellationToken);
        if (token.Kind() == SyntaxKind.EndOfFileToken)
        {
            var triviaList = token.LeadingTrivia;
            foreach (var triviaTok in triviaList.Reverse())
            {
                if (triviaTok.Span.Contains(position))
                {
                    return false;
                }

                if (triviaTok.Span.End < position)
                {
                    if (!triviaTok.HasStructure)
                    {
                        return false;
                    }

                    var structure = triviaTok.GetStructure();
                    if (structure is BranchingDirectiveTriviaSyntax branch)
                    {
                        return !branch.IsActive || !branch.BranchTaken;
                    }
                }
            }
        }

        return false;
    }

    public static bool IsPreProcessorKeywordContext(this SyntaxTree syntaxTree, int position, CancellationToken cancellationToken)
    {
        return IsPreProcessorKeywordContext(
            syntaxTree, position,
            syntaxTree.FindTokenOnLeftOfPosition(position, cancellationToken, includeDirectives: true));
    }

#pragma warning disable IDE0060 // Remove unused parameter
    public static bool IsPreProcessorKeywordContext(this SyntaxTree syntaxTree, int position, SyntaxToken preProcessorTokenOnLeftOfPosition)
#pragma warning restore IDE0060 // Remove unused parameter
    {
        // cases:
        //  #|
        //  #d|
        //  # |
        //  # d|

        // note: comments are not allowed between the # and item.
        var token = preProcessorTokenOnLeftOfPosition;
        token = token.GetPreviousTokenIfTouchingWord(position);

        if (token.IsKind(SyntaxKind.HashToken))
        {
            return true;
        }

        return false;
    }
}