Microsoft.CodeAnalysis.FlowAnalysis.Utilities
Provides and caches well known types in a compilation for .
for
for 'System.Diagnostics.Contracts.Contract' type. />
for
for
for
for
for 'System.Runtime.Serialization.SerializationInfo' type />
for
Mapping of full name to .
Attempts to get the type by the full type name.
Namespace + type name, e.g. "System.Exception".
Named type symbol, if any.
True if found in the compilation, false otherwise.
Set containing following named types, if not null:
1. for
2. for
3. for
Determines if is a with its type
argument satisfying .
Type potentially representing a .
Predicate to check the 's type argument.
True if is a with its
type argument satisfying , false otherwise.
Dataflow analysis to track instances that share the same value.
Predicate kind for
to indicte if the copy equality check for the SetAbstractValue call is a reference compare or a value compare operation.
Abstract value domain for to merge and compare values.
Operation visitor to flow the copy values across a given statement in a basic block.
An abstract analysis domain implementation for .
Generates and stores the default for instances generated for member and element reference operations.
Map builder from entity to set of entities that share the same instance location.
Primarily used for ref arguments for context sensitive interprocedural analysis
to ensure that PointsTo value updates to any of the mapped entities is reflected in the others in the set.
Abstract copy value shared by a set of one of more instances tracked by .
Kind for the .
Not applicable.
Copy of a reference shared by one or more instances.
Copy of a value shared by one or more instances.
Copy may or may not be shared by other instances.
Invalid state for an unreachable path from predicate analysis.
Aggregated copy analysis data tracked by .
Contains the for entity copy values and
the predicated copy values based on true/false runtime values of predicated entities.
Updates the the copy values for all entities that are part of the given set,
i.e. .
We do not support the overload
that updates copy value for each individual entity.
Result from execution of on a basic block.
It store copy values for each at the start and end of the basic block.
Analysis context for execution of on a control flow graph.
Analysis result from execution of on a control flow graph.
Stores all the entities that got tracked during points to analysis
Analysis context for execution of on a control flow graph.
Generates and stores the default for instances generated for member and element reference operations.
Abstract null value for / tracked by .
Abstract PointsTo value for an / tracked by .
It contains the set of possible s that the entity or the operation can point to and the of the location(s).
Kind for the .
Invalid value based on predicate analysis.
Undefined value.
Points to one or more known possible locations.
Points to one or more known possible l-values.
Used for pointers, ref expressions and l-value flow captures.
Points to unknown set of locations, which is known to be null.
Note that this value kind is theoretically not needed, as the underlying
value is null, but it has been added to ensure monotonicity of value merge.
Points to unknown set of locations, which is known to be non-null.
Points to unknown set of locations, which may or may not be null.
Dataflow analysis to track locations pointed to by and instances.
An abstract analysis domain implementation for tracked by .
Abstract value domain to merge and compare values.
Abstract value domain for to merge and compare values.
An abstract analysis domain implementation for tracked by .
Operation visitor to flow the PointsTo values across a given statement in a basic block.
Returns true if this special static factory method whose name starts with "Create", such that
method's containing type is static OR a special type OR derives from or is same as the type of the field/property/method return.
For example: class SomeType { static SomeType CreateXXX(...); }
Returns true if this special member symbol named "Empty", such that one of the following is true:
1. It is a static method with no parameters or
2. It is a static readonly property or
3. It is static readonly field
and symbol's containing type is a special type or derives from or is same as the type of the field/property/method return.
For example:
1. class SomeType { static readonly SomeType Empty; }
2. class SomeType { static readonly SomeType Empty { get; } }
3. class SomeType { static SomeType Empty(); }
Aggregated PointsTo analysis data tracked by .
Contains the for entity PointsTo values and
the predicated values based on true/false runtime values of predicated entities.
Result from execution of on a basic block.
It stores the PointsTo value for each at the start and end of the basic block.
Analysis context for execution of on a control flow graph.
Abstract dispose data tracked by .
It contains the set of s that dispose an associated disposable and
the dispose .
Abstract dispose value for / tracked by .
Indicates locations that are not disposable, e.g. value types, constants, etc.
Indicates a value for disposable locations that are not feasible on the given program path.
For example,
var x = flag ? new Disposable() : null;
if (x == null)
{
// Disposable allocation above cannot exist on this code path.
}
Indicates disposable locations that are not disposed.
Indicates disposable locations that have escaped the declaring method's scope.
For example, a disposable allocation assigned to a field/property or
escped as a return value for a function, or assigned to a ref or out parameter, etc.
Indicates disposable locations that are either not disposed or escaped.
Indicates disposable locations that are disposed.
Indicates disposable locations that may be disposed on some program path(s).
Indicates disposable locations whose dispose state is unknown.
Dataflow analysis to track dispose state of / instances.
Abstract value domain for to merge and compare values.
Operation visitor to flow the dispose values across a given statement in a basic block.
Result from execution of on a basic block.
It store dispose values for each at the start and end of the basic block.
Analysis result from execution of on a control flow graph.
Analysis context for execution of on a control flow graph.
Dataflow analysis to track value content of /.
An abstract analysis domain implementation for tracked by .
An abstract analysis domain implementation for core analysis data tracked by .
Abstract value domain for to merge and compare values.
Operation visitor to flow the data values across a given statement in a basic block.
Value state for presence of non-literal values for / tracked by .
The variable state is invalid due to predicate analysis.
State is undefined.
The variable does not contain any instances of a non-literal.
The variable may or may not contain instances of a non-literal.
Abstract value content data value for / tracked by .
Indicates if this variable contains non literal operands or not.
Gets a collection of the literals that could possibly make up the contents of this abstract value.
Performs the union of this state and the other state
and returns a new with the result.
For super simple cases: If this abstract value is a single literal, then get that literal value.
Type of the expected literal value.
Literal value, or its default if not a single literal value.
True if a literal value was found, false otherwise.
If you're looking for null, you should be looking at .
Performs the union of this state and the other state for a Binary operation
and returns a new with the result.
Aggregated value content analysis data tracked by .
Contains the for entity data values and
the predicated values based on true/false runtime values of predicated entities.
Result from execution of on a basic block.
It stores data values for each at the start and end of the basic block.
Abstract analysis domain for a to merge and compare analysis data.
Creates a clone of the analysis data.
Returns a value that is greater than and .
A value to be merged
A value to be merged
A value that is greater than and
Compares with
and returns a value indicating whether one value is less than,
equal to, or greater than the other.
A value to compare
A value to compare
A signed integer that indicates the relative values of
and .
Less than zero: is less than .
Zero: equals .
Greater than zero: is greater than .
Indicates if with are equal.
A value to compare
A value to compare
Result from execution of a on a basic block.
Interprocedural analysis predicate to decide whether interprocedural analysis can be skipped.
Interprocedural analysis configuration parameters.
Defines the max length for method call chain (call stack size) for interprocedural analysis.
This is done for performance reasons for analyzing methods with extremely large call trees.
https://github.com/dotnet/roslyn-analyzers/issues/1809 tracks improving this heuristic.
Defines the max length for lambda/local function method call chain (call stack size) for interprocedural analysis.
This is done for performance reasons for analyzing methods with extremely large call trees.
https://github.com/dotnet/roslyn-analyzers/issues/1809 tracks improving this heuristic.
Conversion inference result.
Unique flow capture Id across interprocedural flow graph.
This type essentially wraps each , which is unique for each control flow graph,
with its owning .
Contains information about an argument passed to interprocedural analysis.
Determines the kind of interprocedural dataflow analysis to perform for method invocations.
Skip interprocedural analysis for source method invocations, except for lambda and location function invocations,
which are always analyzed in a context sensitive fashion.
All the analysis data for invocation receiver and arguments is conservatively reset at call sites.
Produces least precise results from amongst the possible interprocedural modes, but is the most performant mode.
Performs context sensitive interprocedural analysis for all source method invocations,
including lambda and location function invocations.
Context sensitive interprocedural analysis analyzes invoked method at each call site by considering the calling context,
i.e. the argument values and instance receiver, hence is the most precise analysis mode.
This mode is also the most performance intensive mode.
Note that we apply a max threshold to the length of interprocedural call chain to analyze in
a context sensitive fashion to avoid infinite computation for huge call graphs.
Contains the caller's analysis context data passed to context sensitive interprocedural analysis, .
This includes the following:
1. Caller's tracked analysis data at the call site, which is the initial analysis data for callee.
2. Information about the invocation instance on which the method is invoked.
3. Information about arguments for the invocation.
4. Captured variables (for lambda/local function invocations).
5. Information about ref/out parameter entities that share address with callee's parameters.
6. Operation call stack for the current interprocedural analysis.
7. Set of analysis contexts currently being analyzed.
Marker interface for analysis results from execution of on a control flow graph.
Primarily exists for specifying constraints on analysis result type parameters.
Marker interface for analysis contexts for execution of on a control flow graph.
Primarily exists for specifying constraints on analysis context type parameters.
Base type for analysis contexts for execution of on a control flow graph.
Abstract domain for a to merge and compare values.
Returns the minor value of the domain.
Returns a value that is greater than and .
A value to be merged
A value to be merged
A value that is greater than and
Compares with
and returns a value indicating whether one value is less than,
equal to, or greater than the other.
A value to compare
A value to compare
A signed integer that indicates the relative values of
and .
Less than zero: is less than .
Zero: equals .
Greater than zero: is greater than .
Indicates if and are equal.
A value to compare
A value to compare
Abstract cache based equatable implementation for objects that are compared frequently and hence need a performance optimization of using a cached hash code.
Represents an abstract index into a location.
It is used by an for operations such as an , index access , etc.
Represents an abstract analysis location.
This is may be used to represent a location where an resides, i.e. or
a location that is pointed to by a reference type variable, and tracked with .
An analysis location can be created for one of the following cases:
1. An allocation or an object creation operation ().
2. Location for the implicit 'this' or 'Me' instance being analyzed ().
3. Location created for certain symbols which do not have a declaration in executable code, i.e. no for declaration (such as parameter symbols, member symbols, etc. - />).
4. Location created for flow capture entities, i.e. for created for or .
See
Returns the top of if this location was created through an interprocedural method invocation, i.e. is non-empty.
Otherwise, returns .
Indicates this represents the initial unknown but distinct location for an analysis entity.
Attempts to get the syntax node to report diagnostic for this abstract location
Returns null if the location is owned by another method invoked through interprocedural analysis.
Operation visitor to flow the abstract dataflow analysis values for s across a given statement in a basic block.
Helper method to reset analysis data for analysis locations.
Abstract value domain for a to merge and compare values.
Returns the major Unknown or MayBe top value of the domain.
Primary entity for which analysis data is tracked by .
The entity is based on one or more of the following:
1. An .
2. One or more indices to index into the parent key.
3. "this" or "Me" instance.
4. An allocation or an object creation.
Each entity has:
1. An associated non-null and
2. A non-null indicating the abstract location at which the entity is located and
3. An optional parent key if this key has the same as the parent (i.e. parent is a value type).
Base class for all the aggregate analysis data with predicated analysis data,
whose is keyed by an .
Operation visitor to flow the abstract dataflow analysis values for instances across a given statement in a basic block.
Helper method to reset analysis data for analysis entities.
Resets all the analysis data for all instances that share the same
as the given .
Resets the analysis data for the given .
Transfers the analysis data rooted from or to , for a value type assignment operation.
This involves transfer of data for of all instances that share the same as or allocation for the
to all instances that share the same as .
Returns a cloned CurrentAnalysisData, trimmed down to only have key-value pairs for the given .
Factory to create objects for operations, symbol declarations, etc.
This factory also tracks analysis entities that share the same instance location (e.g. value type members).
NOTE: This factory must only be used from within an , as it is tied to the visitor's state tracking via delegate.
An abstract domain implementation for analyses that store dictionary typed data.
Subtype for all dataflow analyses on a control flow graph.
It performs a worklist based approach to flow abstract data values for / across the basic blocks until a fix point is reached.
Result from execution of a on a control flow graph.
It stores:
(1) Analysis values for all operations in the graph and
(2) for every basic block in the graph.
(3) Merged analysis state for all the unhandled throw operations in the graph.
Used by to store intermediate dataflow results while executing data flow analysis
and also to compute the final exposed as the result.
Operation visitor to flow the abstract dataflow analysis values across a given statement in a basic block.
Defines the max length for method call chain (call stack size) for interprocedural analysis.
This is done for performance reasons for analyzing methods with extremely large call trees.
Defines the max length for lambda/local function method call chain (call stack size) for interprocedural analysis.
This is done for performance reasons for analyzing methods with extremely large call trees.
Stores a map from entity to set of entities that share the same instance location.
Primarily used for ref arguments for context sensitive interprocedural analysis
to ensure that PointsTo value updates to any of the mapped entities is reflected in the others in the set.
Current interprocedural operation call stack.
Dictionary storing context sensitive interprocedural analysis results for each callsite.
Dictionary from interprocedural method symbols invoked to their corresponding .
Optional map from points to values of tasks to the underlying abstract value returned by the task.
Awaiting the task produces the task wrapped value from this map.
This boolean field determines if the caller requires an optimistic OR a pessimistic analysis for such cases.
For example, invoking an instance method may likely invalidate all the instance field analysis state, i.e.
reference type fields might be re-assigned to point to different objects in the called method.
An optimistic points to analysis assumes that the points to values of instance fields don't change on invoking an instance method.
A pessimistic points to analysis resets all the instance state and assumes the instance field might point to any object, hence has unknown state.
For dispose analysis, we want to perform an optimistic points to analysis as we assume a disposable field is not likely to be re-assigned to a separate object in helper method invocations in Dispose.
For value content analysis, we want to perform a pessimistic points to analysis to be conservative and avoid missing out true violations.
Indicates if we this visitor needs to analyze predicates of conditions.
PERF: Track if we are within an .
Primary method that flows analysis data through the given statement.
Updates values for existing entries in with newer values from CurrentAnalysisData.
Helper method to update analysis data for existing entries in
with newer values from .
Primary method that flows analysis data through the given flow edge/branch.
Returns false if the branch is conditional and the branch value always evaluates to false.
Get analysis value for an implicitly created completed task wrapping a returned value in an async method.
For example, "return 0;" in an async method returning "Task(Of int)".
Resets all the analysis data for all instances that share the same
as the given .
Resets all the analysis data for all instances that share the same
as the given .
Resets all the analysis data for all instances that share the same
as pointed to by given reference type .
Reset all the instance analysis data if is true and is also true.
If we are using or performing points to analysis, certain operations can invalidate all the analysis data off the containing instance.
Gets a new instance of analysis data that should be passed as initial analysis data
for interprocedural analysis.
The default implementation returns cloned CurrentAnalysisData.
Apply the result data from interprocedural analysis to CurrentAnalysisData.
Default implementation is designed for the default implementation of GetInitialInterproceduralAnalysisData.
and overwrites the CurrentAnalysisData with the given .
Invoked after the parent invocation/creation operation of the given argument has been visited.
Argument to be post-processed.
Boolean flag indicating if the argument was escaped due to lack of interprocedural analysis or not.
Post process argument which needs to be escaped/reset after being passed to an invocation/creation target
without interprocedural analysis.
This method resets the analysis data for an object instance passed around as an
and also handles resetting the argument value for ref/out parmater.
Visits an invocation, either as a direct method call, or intermediately through a delegate.
Method that is invoked.
Instance that that the method is invoked on, if any.
Arguments to the invoked method.
Indicates that invocation is a delegate invocation.
Original invocation operation, which may be a delegate invocation.
Default abstract value to return.
Abstract value of return value.
Reset all the instance analysis data for if is true and is also true.
If we are using or performing points to analysis, certain operations can invalidate all the analysis data off the containing instance.
Subtype for all forward dataflow analyses.
These analyses operate on the control flow graph starting from the entry block,
flowing the dataflow values forward to the successor blocks until a fix point is reached.
Helper class to detect s that are l-value captures.
An abstract domain implementation for analyses that store dictionary typed data.
Compares if the abstract dataflow values in against the values in to ensure
dataflow function is a monotically increasing function. See https://en.wikipedia.org/wiki/Monotonic_function for understanding monotonic functions.
1) 0, if both the dictionaries are identical.
2) -1, if dictionaries are not identical and for every key in , the corresponding key exists in and
the value of each such key in is lesser than or equals the value in .
3) 1, otherwise.
Base class for all the predicated analysis data.
It tracks , which contains the true/false for every predicated , and
, which tracks if the current data is for a reachable code path based on the predicate analysis.
Predicate analysis data is used to improve the preciseness of analysis when we can apply the or
on the control flow paths where the corresonding is known to have true or false value respectively.
Analysis data predicated by true/false value of an .
Used to improve the preciseness of analysis when we can apply the or
on the control flow paths where the corresonding is known to have true or false value respectively.
Analysis data for true value of the corresponding on which this data is predicated.
null value indicates the corresponding can never be true.
Analysis data for false value of the corresponding on which this data is predicated.
null value indicates the corresponding can never be false.
An abstract domain implementation for analyses that store dictionary typed data along with predicated data.
Predicate always evaluates to true.
Predicate always evaluates to false.
Predicate might evaluate to true or false.
Stack guard for to ensure sufficient stack while recursively visiting the operation tree.
Ordinal of the basic block where this exception is thrown.
Optional catch handler that handles this exception.
If the exception happens within a finally region, this points to that finally.
Contains aggregated information about a control flow branch.
Returns true if the given is contained in a control flow region with the given .
Returns the innermost control flow region of the given that contains the given .
Returns true if the given basic block is the first block of a finally region.
Returns true if the given basic block is the last block of a finally region.
Returns true if the given basic block is the first block of a region of the given regionKind.
Returns true if the given basic block is the last block of a region of the given regionKind.
Gets the maximum ordinal of a conditional or fall through successor of the given basic block.
Returns -1 if the block has no conditional or fall through successor,
for example, if the block only has a structured exception handling branch for throw operation.
Calculates computational complexity metrics based on the number
of operators and operands found in the code.
This metric is based off of the Halstead metric.
The number of unique operators found.
The number of unique operands found.
The total number of operator usages found.
The total number of operand usages found.
Returns the number of elements in a sequence.
he type of the elements of .
A sequence that contains elements to be counted.
The number of elements in the input sequence.
Determines whether a sequence contains, exactly, elements.
The type of the elements of source.
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains, exactly, elements; otherwise, .
Determines whether a sequence containsmore than elements.
The type of the elements of source.
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains more than elements; otherwise, .
Determines whether a sequence contains fewer than elements.
The type of the elements of source.
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains less then elements; otherwise, .
struct enumerator used in foreach.
Realizes the array.
Write to slot .
Fills in unallocated slots preceding the , if any.
Realizes the array.
Realizes the array, downcasting each element to a derived type.
Realizes the array and disposes the builder in one operation.
Generic implementation of object pooling pattern with predefined pool size limit. The main
purpose is that limited number of frequently used objects can be kept in the pool for
further recycling.
Notes:
1) it is not the goal to keep all returned objects. Pool is not meant for storage. If there
is no space in the pool, extra returned objects will be dropped.
2) it is implied that if object was obtained from a pool, the caller will return it back in
a relatively short time. Keeping checked out objects for long durations is ok, but
reduces usefulness of pooling. Just new up your own.
Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice.
Rationale:
If there is no intent for reusing the object, do not use pool - just use "new".
Not using System.Func{T} because this file is linked into the (debugger) Formatter,
which does not have that type (since it compiles against .NET 2.0).
Produces an instance.
Search strategy is a simple linear probing which is chosen for it cache-friendliness.
Note that Free will try to store recycled objects close to the start thus statistically
reducing how far we will typically search.
Returns objects to the pool.
Search strategy is a simple linear probing which is chosen for it cache-friendliness.
Note that Free will try to store recycled objects close to the start thus statistically
reducing how far we will typically search in Allocate.
Removes an object from leak tracking.
This is called when an object is returned to the pool. It may also be explicitly
called if an object allocated from the pool is intentionally not being returned
to the pool. This can be of use with pooled arrays if the consumer wants to
return a larger array to the pool than was originally allocated.
Provides bounded cache for analyzers.
Acts as a good alternative to
when the cached value has a cyclic reference to the key preventing early garbage collection of entries.
Walks an IOperation tree to find catch blocks that handle general types without rethrowing them.
This will only compile if and have the
same value.
The subtraction in will overflow if is greater, and the conversion
to an unsigned value after negation in will overflow if is greater.
This will only compile if and have the
same value.
The subtraction in will overflow if is greater, and the conversion
to an unsigned value after negation in will overflow if is greater.
Determines whether a sequence contains, exactly, elements.
The type of the elements of source.
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains, exactly, elements; otherwise, .
is null.
Determines whether a sequence contains more than elements.
The type of the elements of .
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains more than elements; otherwise, .
is null.
Determines whether a sequence contains fewer than elements.
The type of the elements of .
The to check for cardinality.
The number of elements to ensure exists.
the source sequence contains less than elements; otherwise, .
is null.
Excludes that have an attribute that precisely matches .
List of to filter.
The of the attribute class to search.
A filtered list of methods.
Returns a list of method symbols from a given list of the method symbols, which has its parameter type as
expectedParameterType as its first parameter or the last parameter in addition to matching all the other
parameter types of the selectedOverload method symbol
List of to scan for possible overloads
that is currently picked by the user
type of the leading parameter or the trailing parameter
If the expected parameter should appear at the trailing position of the parameter list of the method overload
Returns a list of method symbols from a given list of the method symbols, which has its parameter type as
expectedParameterType as its last parameter in addition to matching all the other parameter types of the
selectedOverload method symbol
List of to scan for possible overloads
that is currently picked by the user
type of the leading parameter or the trailing parameter
Given a , this method returns the method symbol which
matches the expectedParameterTypesInOrder parameter requirement
Checks if the given method overrides .
Checks if the given method is .
Checks if the given is or .
Checks if the given method overrides Object.GetHashCode.
Checks if the given method overrides Object.ToString.
Checks if the given method overrides a method from System.Object
Checks if the given method is a Finalizer implementation.
Checks if the given method is an implementation of the given interface method
Substituted with the given typeargument.
Checks if the given method implements IDisposable.Dispose()
Checks if the given method implements or overrides an implementation of .
Checks if the given method has the signature "void Dispose()".
Checks if the given method has the signature "void Dispose(bool)".
Checks if the given method has the signature "void Close()".
Checks if the given method has the signature "Task DisposeAsync()".
Checks if the given method has the signature "override Task DisposeCoreAsync(bool)".
Gets the for the given method.
Gets the for the given method.
Checks if the given method implements 'System.Runtime.Serialization.IDeserializationCallback.OnDeserialization' or overrides an implementation of 'System.Runtime.Serialization.IDeserializationCallback.OnDeserialization'/>.
Checks if the method is a property getter.
Checks if the method is the getter for an indexer.
Checks if the method is an accessor for a property.
Checks if the method is an accessor for an event.
Determine if the specific method is an Add method that adds to a collection.
The method to test.
Collection types.
'true' if is believed to be the add method of a collection.
The current heuristic is that we consider a method to be an add method if its name begins with "Add" and its
enclosing type derives from ICollection or any instantiation of ICollection<T>.
Determine if the specific method is a Task.FromResult method that wraps a result in a task.
The method to test.
Task type.
Determine if the specific method is a Task.ConfigureAwait(bool) method.
The method to test.
Generic task type.
PERF: Cache from method symbols to their topmost block operations to enable interprocedural flow analysis
across analyzers and analyzer callbacks to re-use the operations, semanticModel and control flow graph.
Also see
Returns the topmost for given .
Returns true for void returning methods with two parameters, where
the first parameter is of type and the second
parameter inherits from or equals type.
Find out if the method overrides from target virtual method of a certain type
or it is the virtual method itself.
The method
The type has virtual method
Returns true if this is a bool returning static method whose name starts with "IsNull"
with a single parameter whose type is not a value type.
For example, "static bool string.IsNullOrEmpty()"
Returns a value indicating whether derives from, or implements
any generic construction of, the type defined by .
This method only works when is a definition,
not a constructed type.
If is the class Stack>T>, then this
method will return true when called on Stack>int>
or any type derived it, because Stack>int> is constructed from
Stack>T>.
Similarly, if is the interface IList>T>,
then this method will return true for List>int>
or any other class that extends IList>> or an class that implements it,
because IList>int> is constructed from IList>T>.
Returns a value indicating whether the specified type implements both the
equality and inequality operators.
A symbols specifying the type to examine.
true if the type specified by implements both the
equality and inequality operators, otherwise false.
Returns a value indicating whether the specified type implements the comparison
operators.
A symbols specifying the type to examine.
true if the type specified by implements the comparison
operators (which includes the equality and inequality operators), otherwise false.
Returns a value indicating whether the specified symbol is a static
holder type.
The symbol being examined.
true if is a static holder type;
otherwise false.
A symbol is a static holder type if it is a class with at least one
"qualifying member" () and no
"disqualifying members" ().
Returns a value indicating whether the specified symbol qualifies as a
member of a static holder class.
The member being examined.
true if qualifies as a member of
a static holder class; otherwise false.
Returns a value indicating whether the presence of the specified symbol
disqualifies a class from being considered a static holder class.
The member being examined.
true if the presence of disqualifies the
current type as a static holder class; otherwise false.
Gets the receiver type for an invocation expression (i.e. type of 'A' in invocation 'A.B()')
If the invocation actually involves a conversion from A to some other type, say 'C', on which B is invoked,
then this method returns type A if is true, and C if false.
Filters out operations that are implicit and have no explicit descendant with a constant value or a non-null type.
Gets explicit descendants or self of the given that have no explicit ancestor in
the operation tree rooted at .
Operation
True if this operation has no IOperation API support, i.e. and
is the root operation, i.e. is null.
For example, this returns true for attribute operations.
Returns the topmost containing the given .
Gets the first ancestor of this operation with:
1. Specified OperationKind
2. If is non-null, it succeeds for the ancestor.
Returns null if there is no such ancestor.
Gets the operation for the object being created that is being referenced by .
If the operation is referencing an implicit or an explicit this/base/Me/MyBase/MyClass instance, then we return "null".
Flag to indicate if the operation is a descendant of an .
PERF: Note that the parameter is to improve performance by avoiding walking the entire IOperation parent for non-initializer cases.
Workaround for https://github.com/dotnet/roslyn/issues/22736 (IPropertyReferenceExpressions in IAnonymousObjectCreationExpression are missing a receiver).
Gets the instance for the anonymous object being created that is being referenced by .
Otherwise, returns null
Indicates if the given is a predicate operation used in a condition.
PERF: Cache from operation roots to their corresponding to enable interprocedural flow analysis
across analyzers and analyzer callbacks to re-use the control flow graph.
Also see
Gets the symbols captured from the enclosing function(s) by the given lambda or local function.
Operation representing the lambda or local function.
Method symbol for the lambda or local function.
If the given is a nested tuple,
gets the parenting tuple operation and the tuple element of that parenting tuple
which contains the given tupleOperation as a descendant operation.
Walks down consequtive parenthesized operations until an operand is reached that isn't a parenthesized operation.
The starting operation.
The inner non parenthesized operation or the starting operation if it wasn't a parenthesized operation.
Walks up consequtive parenthesized operations until a parent is reached that isn't a parenthesized operation.
The starting operation.
The outer non parenthesized operation or the starting operation if it wasn't a parenthesized operation.
Walks down consequtive conversion operations until an operand is reached that isn't a conversion operation.
The starting operation.
The inner non conversion operation or the starting operation if it wasn't a conversion operation.
Walks up consequtive conversion operations until a parent is reached that isn't a conversion operation.
The starting operation.
The outer non conversion operation or the starting operation if it wasn't a conversion operation.
Returns true if the given symbol has required visibility based on options:
1. If user has explicitly configured candidate in editor config options and
given symbol's visibility is one of the candidate visibilites.
2. Otherwise, if user has not configured visibility, and given symbol's visibility
matches the given default symbol visibility.
Returns true if the given symbol has been configured to be excluded from analysis by options.
True if the symbol is externally visible outside this assembly.
Format member names in a way consistent with FxCop's display format.
A string representing the name of the member in a format consistent with FxCop.
Check whether given parameters contains any parameter with given type.
Get parameters which type is the given type
Check whether given overloads has any overload whose parameters has the given type as its parameter type.
Convert given parameters to the indices to the given method's parameter list.
Check whether parameter count and parameter types of the given methods are same.
Check whether parameter types of the given methods are same for given parameter indices.
Check whether return type, parameters count and parameter types are same for the given methods.
Check whether given symbol is from mscorlib
Get overload from the given overloads that matches given method signature + given parameter
Checks if a given symbol implements an interface member implicitly or explicitly
Checks if a given symbol implements an interface member implicitly
Checks if a given symbol implements an interface member or overrides an implementation of an interface member.
Gets the symbol overridden by the given .
Requires that is true for the given .
Checks if a given symbol implements an interface member explicitly
Returns a value indicating whether the specified symbol has the specified
attribute.
The symbol being examined.
The attribute in question.
true if has an attribute of type
; otherwise false.
If is a type, this method does not find attributes
on its base types.
Indicates if a symbol has at least one location in source.
Returns true for symbols whose name starts with an underscore and
are optionally followed by an integer, such as '_', '_1', '_2', etc.
These symbols can be treated as special discard symbol names.
Indicates if the given implements .
Indicates if the given is a reference type that implements or is type itself.
Gets all attributes directly applied to the type or inherited from a base type.
The type symbol.
The compilation symbol for .
Extensions for .
Determines whether is at least as visible as .
The visibility to compare against.
The visibility to compare with.
True if one can say that is at least as visible as .
For example, is at least as visible as , but is not as visible as .
Describes different kinds of Dispose-like methods.
Not a dispose-like method.
An override of .
A virtual method named Dispose that takes a single Boolean parameter, as
is used when implementing the standard Dispose pattern.
A method named DisposeAsync that has no parameters and returns Task.
An overridden method named DisposeCoreAsync that takes a single Boolean parameter and returns Task, as
is used when implementing the standard DisposeAsync pattern.
A method named Close on a type that implements .
Option names to configure analyzer execution through an .editorconfig file.
Option names to configure analyzer execution through an .editorconfig file.
Option to configure analyzed API surface.
Allowed option values: One or more fields of flags enum as a comma separated list.
Boolean option to exclude analysis of async void methods.
Option to configure analyzed output kinds, i.e. of the compilation.
Allowed option values: One or more fields of as a comma separated list.
Boolean option to configure if single letter type parameter names are not flagged for CA1715 (https://docs.microsoft.com/visualstudio/code-quality/ca1715-identifiers-should-have-correct-prefix).
Integral option to configure sufficient IterationCount when using weak KDF algorithm.
String option to configure names of null check validation methods (separated by '|') that validate arguments passed to the method are non-null for CA1062 (https://docs.microsoft.com/visualstudio/code-quality/ca1062-validate-arguments-of-public-methods).
Allowed method name formats:
1. Method name only (includes all methods with the name, regardless of the containing type or namespace)
2. Fully qualified names in the symbol's documentation ID format: https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format
with an optional "M:" prefix.
String option to configure names of symbols (separated by '|') that are excluded for analysis.
Configurable rules: CA1303 (https://docs.microsoft.com/visualstudio/code-quality/ca1303-do-not-pass-literals-as-localized-parameters).
Allowed method name formats:
1. Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
2. Fully qualified names in the symbol's documentation ID format: https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format.
Note that each symbol name requires a symbol kind prefix, such as "M:" prefix for methods, "T:" prefix for types, "N:" prefix for namespaces, etc.
3. ".ctor" for constructors and ".cctor" for static constructors
String option to configure names of types (separated by '|'), so that the type and all its derived types are excluded for analysis.
Configurable rules: CA1303 (https://docs.microsoft.com/visualstudio/code-quality/ca1303-do-not-pass-literals-as-localized-parameters).
Allowed method name formats:
1. Type name only (includes all types with the name, regardless of the containing type or namespace)
2. Fully qualified names in the symbol's documentation ID format: https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md#id-string-format
with an optional "T:" prefix.
Enumeration option to configure unsafe DllImportSearchPath bits when using DefaultDllImportSearchPaths attribute.
Do not use the OR operator to represent the bitwise combination of its member values, use the integeral value directly.
Option to configure interprocedural dataflow analysis kind, i.e. .
Allowed option values: Fields from .
Integral option to configure maximum method call chain for interprocedural dataflow analysis.
Integral option to configure maximum lambda or local function call chain for interprocedural dataflow analysis.
String option to configure dispose analysis kind, primarily for CA2000 (DisposeObjectsBeforeLosingScope).
Allowed option values: Fields from DisposeAnalysisKind enum.
Boolean option to configure if passing a disposable object as a constructor argument should be considered
as a dispose ownership transfer, primarily for CA2000 (DisposeObjectsBeforeLosingScope).
Boolean option to configure if passing a disposable object as an argument to a method invocation should be considered
as a dispose ownership transfer to the caller, primarily for CA2000 (DisposeObjectsBeforeLosingScope)
Option to configure whether copy analysis should be executed during dataflow analysis.
Copy analysis tracks value and reference copies. For example,
void M(string str1, string str2)
{
if (str1 != null)
{
if (str1 == str2)
{
if (str2 != null) // This is redundant as 'str1' and 'str2' are value copies on this code path. This requires copy analysis.
{
}
}
}
}
Describes a group of effective for symbols.
Analyzer configuration options from an .editorconfig file that are parsed into general
and specific configuration options.
.editorconfig format:
1) General configuration option:
(a) "dotnet_code_quality.OptionName = OptionValue"
2) Specific configuration option:
(a) "dotnet_code_quality.RuleId.OptionName = OptionValue"
(b) "dotnet_code_quality.RuleCategory.OptionName = OptionValue"
.editorconfig examples to configure API surface analyzed by analyzers:
1) General configuration option:
(a) "dotnet_code_quality.api_surface = all"
2) Specific configuration option:
(a) "dotnet_code_quality.CA1040.api_surface = public, internal"
(b) "dotnet_code_quality.Naming.api_surface = public"
See for allowed symbol visibility value combinations.
Parses a given .editorconfig source text into .
A set of keys that are reserved for special interpretation for the editorconfig specification.
All values corresponding to reserved keys in a (key,value) property pair are always lowercased
during parsing.
This list was retrieved from https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
at 2018-04-21 19:37:05Z. New keys may be added to this list in newer versions, but old ones will
not be removed.
A set of values that are reserved for special use for the editorconfig specification
and will always be lower-cased by the parser.
A placeholder value type for used as a set.
Provides bounded cache for analyzers.
Acts as a good alternative to
when the cached value has a cyclic reference to the key preventing early garbage collection of entries.
Provides methods for parsing words from text.
Initializes a new instance of the class with the specified text and options.
A containing the text to parse.
One or more of the specifying parsing and delimiting options.
is .
is not one or more of the values.
Initializes a new instance of the class with the specified text, options and prefix.
A containing the text to parse.
One or more of the specifying parsing and delimiting options.
A representing an optional prefix of , that if present,
will be returned as a separate token.
is .
is not one or more of the values.
Returns the words contained in the specified text, delimiting based on the specified options.
A containing the text to parse.
One or more of the specifying parsing and delimiting options.
A of strings containing the words contained in .
is .
is not one or more of the values.
Returns the words contained in the specified text, delimiting based on the specified options.
A containing the text to parse.
One or more of the specifying parsing and delimiting options.
A representing an optional prefix of , that if present,
will be returned as a separate token.
A of strings containing the words contained in .
is .
is not one or more of the values.
Returns a value indicating whether at least one of the specified words occurs, using a case-insensitive ordinal comparison, within the specified text.
A containing the text to check.
One or more of the specifying parsing and delimiting options.
A array containing the words to seek.
if at least one of the elements within occurs within , otherwise, .
is .
-or-
is .
is not one or more of the values.
Returns a value indicating whether at least one of the specified words occurs, using a case-insensitive ordinal comparison, within the specified text.
A containing the text to check.
One or more of the specifying parsing and delimiting options.
A representing an optional prefix of , that if present,
will be returned as a separate token.
A array containing the words to seek.
if at least one of the elements within occurs within , otherwise, .
is .
-or-
is .
is not one or more of the values.
Returns the next word in the text.
A containing the next word or if there are no more words.
Returns the next word in the text without consuming it.
A containing the next word or if there are no more words.
Defines the word parsing and delimiting options for use with .
Indicates the default options for word parsing.
Indicates that should ignore the mnemonic indicator characters (&) embedded within words.
Indicates that should split compound words.
Helper for DisposeAnalysis.
Returns true if the given was created for an allocation in the
or represents a location created for a constructor parameter whose type indicates dispose ownership transfer.
Describes a group of effective for symbols.
Track and report missing dispose violations on all paths (non-exception and exception paths).
Additionally, also flag use of non-recommended dispose patterns that may cause
potential dispose leaks.
Track and report missing dispose violations on all paths (non-exception and exception paths).
Do not flag use of non-recommended dispose patterns that may cause
potential dispose leaks.
Track and report missing dispose violations only on non-exception program paths.
Additionally, also flag use of non-recommended dispose patterns that may cause
potential dispose leaks.
Track and report missing dispose violations only on non-exception program paths.
Do not flag use of non-recommended dispose patterns that may cause
potential dispose leaks.
Like ConcurrentDictionary, but single threaded valueFactory execution in GetOrAdd.
Useful for long running valueFactory functions, like say performing
dataflow analysis. This way DFA is invoked only once per key, even if multiple
threads simultaneously request the same key.
An Entry itself serves a lock object, and contains the real value.
Holds entries, which contain the actual values.
Adds a key/value pair using the specified function if the key does not already exist. Returns the new value, or the existing value if the key exists.
Key to add.
Function to be invoked to generate the key, if necessary.
Value of the key, which will either be the existing value, or new value if the key was not in the dictionary.