dotnet/roslyn

Convenience API to provide operation blocks/roots for a given symbol

Open

#28,097 opened on Jun 25, 2018

View on GitHub
 (0 comments) (2 reactions) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-AnalyzersArea-CompilersFeature - IOperationFeature Requesthelp wanted

Description

Currently, an analyzer can register an operation block action and get hold of all operation blocks for each symbol that has an associated executable code block. This issue tracks exposing a convenience API for non-analyzer clients to get operations blocks for a given symbol.

See second bullet point in Essentials section in the comment from @bkoelman here: https://github.com/dotnet/roslyn/issues/27208#issuecomment-396575101

An API to get operation block(s) from an IMethodSymbol. My current solution via syntax is tedious and probably incomplete. A reliable API that works on symbols for methods, fields and other places that may contain a code block (and which works for both blocks and expression bodies) would be very welcome.

Contributor guide

Tech stack
csharp
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# programmingRoslyn API basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Study the existing operation block API in Roslyn, specifically how analyzers register operation block actions. Explore the IOperation interface and the ControlFlowAnalysis API. Look at the comment by @bkoelman for more context. The implementation would involve exposing a method on a public API surface, likely in the Microsoft.CodeAnalysis namespace. Consider adding a GetOperationBlocks method to IOperation or a helper class.