|
// 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.
namespace Microsoft.CodeAnalysis
{
/// <summary>
/// Represents a local variable in method body.
/// </summary>
/// <remarks>
/// This interface is reserved for implementation by its associated APIs. We reserve the right to
/// change it in the future.
/// </remarks>
public interface ILocalSymbol : ISymbol
{
/// <summary>
/// Gets the type of this local variable.
/// </summary>
ITypeSymbol Type { get; }
/// <summary>
/// Gets the top-level nullability of this local variable.
/// </summary>
NullableAnnotation NullableAnnotation { get; }
/// <summary>
/// Returns true if this local variable was declared as "const" (i.e. is a constant declaration).
/// Also returns true for an enum member.
/// </summary>
bool IsConst { get; }
/// <summary>
/// Returns true if this local is a ref local or a ref readonly local.
/// Use <see cref="RefKind"/> to get more detailed information.
/// </summary>
bool IsRef { get; }
/// <summary>
/// Whether the variable is a ref or ref readonly local.
/// </summary>
RefKind RefKind { get; }
/// <summary>
/// Returns the scoped kind of the local.
/// </summary>
ScopedKind ScopedKind { get; }
/// <summary>
/// Returns false if the local variable wasn't declared as "const", or constant value was omitted or erroneous.
/// True otherwise.
/// </summary>
bool HasConstantValue { get; }
/// <summary>
/// Gets the constant value of this local variable.
/// </summary>
object? ConstantValue { get; }
/// <summary>
/// Returns true if this local variable is function return variable whose name is the function's name,
/// whose type is the return type of the function and whose initial value is the default of its type.
/// </summary>
/// <remarks>
/// Is always false for the C# local variable
/// </remarks>
bool IsFunctionValue { get; }
/// <summary>
/// Returns true if the local variable is declared with fixed-pointer-initializer (in unsafe context).
/// </summary>
bool IsFixed { get; }
/// <summary>
/// Returns true if this local variable is declared as iteration variable
/// </summary>
bool IsForEach { get; }
/// <summary>
/// Returns true if the local variable is declared in resource-acquisition of a 'using statement';
/// otherwise false
/// </summary>
/// <example>
/// <code>
/// using (var localVariable = new StreamReader(path)) { ... }
/// </code>
/// </example>
bool IsUsing { get; }
}
}
|