Class SourceCodeInfo.Types.Location

Inheritance
System.Object
SourceCodeInfo.Types.Location
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Protobuf.Reflection
Assembly: Google.Protobuf.dll
Syntax
public sealed class Location : IMessage<SourceCodeInfo.Types.Location>, IMessage, IEquatable<SourceCodeInfo.Types.Location>, IDeepCloneable<SourceCodeInfo.Types.Location>

Constructors

Location()

Declaration
public Location()

Location(SourceCodeInfo.Types.Location)

Declaration
public Location(SourceCodeInfo.Types.Location other)
Parameters
Type Name Description
SourceCodeInfo.Types.Location other

Fields

LeadingCommentsFieldNumber

Field number for the "leading_comments" field.

Declaration
public const int LeadingCommentsFieldNumber = 3
Field Value
Type Description
System.Int32

LeadingDetachedCommentsFieldNumber

Field number for the "leading_detached_comments" field.

Declaration
public const int LeadingDetachedCommentsFieldNumber = 6
Field Value
Type Description
System.Int32

PathFieldNumber

Field number for the "path" field.

Declaration
public const int PathFieldNumber = 1
Field Value
Type Description
System.Int32

SpanFieldNumber

Field number for the "span" field.

Declaration
public const int SpanFieldNumber = 2
Field Value
Type Description
System.Int32

TrailingCommentsFieldNumber

Field number for the "trailing_comments" field.

Declaration
public const int TrailingCommentsFieldNumber = 4
Field Value
Type Description
System.Int32

Properties

Descriptor

Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

HasLeadingComments

Gets whether the "leading_comments" field is set

Declaration
public bool HasLeadingComments { get; }
Property Value
Type Description
System.Boolean

HasTrailingComments

Gets whether the "trailing_comments" field is set

Declaration
public bool HasTrailingComments { get; }
Property Value
Type Description
System.Boolean

LeadingComments

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment.

leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field.

Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output.

Examples:

optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2;

optional string baz = 3; // Comment attached to baz. // Another line attached to baz.

// Comment attached to qux. // // Another line attached to qux. optional double qux = 4;

// Detached comment for corge. This is not leading or trailing comments // to qux or corge because there are blank lines separating it from // both.

// Detached comment for corge paragraph 2.

optional string corge = 5; /* Block comment attached

  • to corge. Leading asterisks
  • will be removed. / / Block comment attached to
  • grault. */ optional int32 grault = 6;

// ignored detached comments.

Declaration
public string LeadingComments { get; set; }
Property Value
Type Description
System.String

LeadingDetachedComments

Declaration
public RepeatedField<string> LeadingDetachedComments { get; }
Property Value
Type Description
RepeatedField<System.String>

Parser

Declaration
public static MessageParser<SourceCodeInfo.Types.Location> Parser { get; }
Property Value
Type Description
MessageParser<SourceCodeInfo.Types.Location>

Path

Identifies which part of the FileDescriptorProto was defined at this location.

Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1;

Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).

Declaration
public RepeatedField<int> Path { get; }
Property Value
Type Description
RepeatedField<System.Int32>

Span

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user.

Declaration
public RepeatedField<int> Span { get; }
Property Value
Type Description
RepeatedField<System.Int32>

TrailingComments

Declaration
public string TrailingComments { get; set; }
Property Value
Type Description
System.String

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

ClearLeadingComments()

Clears the value of the "leading_comments" field

Declaration
public void ClearLeadingComments()

ClearTrailingComments()

Clears the value of the "trailing_comments" field

Declaration
public void ClearTrailingComments()

Clone()

Declaration
public SourceCodeInfo.Types.Location Clone()
Returns
Type Description
SourceCodeInfo.Types.Location
Implements

Equals(SourceCodeInfo.Types.Location)

Declaration
public bool Equals(SourceCodeInfo.Types.Location other)
Parameters
Type Name Description
SourceCodeInfo.Types.Location other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

MergeFrom(SourceCodeInfo.Types.Location)

Declaration
public void MergeFrom(SourceCodeInfo.Types.Location other)
Parameters
Type Name Description
SourceCodeInfo.Types.Location other
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements

Extension Methods